Documentation map
Use this page as a table of contents for the expanded docs. Sections mirror the sidebar.
Start here
| Page | What you get |
|---|---|
| Home | Hero, feature overview; deployed to moxiedocs.foxnews.com via GitHub Pages |
| Setup | Prerequisites, clone, install, first request, project structure |
| Local development | Yarn commands, port 3001, MOXIE_ENV, static URLs |
| Unmoxed & tunnels | UNMOXED_*, local broker, yarn dev:tunnel |
Core concepts
| Page | What you get |
|---|---|
| Architecture | API Gateway → Lambda → Setup → Moxie → Router → handler |
| Router & routes | Route keys, group, resolution order, shared vs site |
| Frameworks & patterns | JSON API, template, mobile.tab, mobile.spark.tab, staticish |
| Moxie runtime API | moxie.throw, log, debugga, globals, context |
| Identity & environments | moxie.identity, MOXIE_ENV, ?env= |
| Multi-site & shared APIs | fn/fb/fw/ok, src/apis/shared patterns |
Settings & HTTP behavior
| Page | What you get |
|---|---|
| Settings reference | routes/, env/, sites/, caching/, specs/ |
| Caching deep dive | Policy buckets, CDN semantics, liveblog vs standard |
| Response specifications | json, json-api, mobile, xml, swagger, etc. |
Cookbooks (how to build)
| Page | What you get |
|---|---|
| Cookbook: new endpoint | Step-by-step from route to first successful response |
| JSON:API mapping guide | map, pluck, compute, rewrite, parse, pitfalls |
| Querystrings & config.js | querystrings.options types, defaults, validation |
| Template & doT | config.sources, template.dot, ?template= override |
API surfaces
| Page | What you get |
|---|---|
| Mobile platform guide | FN / FB / FW mobile tables, frameworks, querystrings |
| Partner feeds overview | RSS/XML partners, OOH, implementation checklist |
| Endpoints quick reference | Mobile, CMS, RSS, web, tools (path tables) |
Platform & integrations
| Page | What you get |
|---|---|
| External clients | Spark, Brightcove, Delta, Aurora, S3, Hypertext |
| Static files & S3 | static/public, /static/, /s3/, CI sync |
| Webpack & bundle | Single Lambda artifact, doT compile, @app alias |
Quality, delivery, operations
| Page | What you get |
|---|---|
| Testing | Jest, where tests live, CI expectations |
| Lint, format, hooks | Biome, Lefthook, yarn lint / format |
| Git workflow & releases | develop, release-v*, GitHub Release → prod |
| Infrastructure & CI/CD | Terraform summary, workflows, buckets |
| Security & secrets | env.js, TF vars, GitHub Secrets, local gaps |
| Troubleshooting | Common failures, debug order, who to ask |
Reference misc
| Page | What you get |
|---|---|
| Debugging (debugga) | Query flags by area |
| Code conventions | snake_case, colors, errors, logging |
| Glossary | Terms and acronyms |