Owner: Engineering Team | Last Updated: 2026-01-31 | Status: Current
Standards for writing and maintaining this wiki documentation. All pages must follow the templates, callout conventions, cross-linking rules, and navigation patterns defined here.
Every page must follow one of these 5 templates:
Setup pages use this structure: Title, Prerequisites callout, Quick Reference table, Numbered steps, Troubleshooting table, Related Pages, Changelog, Navigation footer.
Overview pages use this structure: Title, Owner metadata, Context paragraph, Tech Stack table, Architecture diagram, Project Structure tree, Related Pages, Changelog, Navigation footer.
Architecture pages use this structure: Title, Scope callout (what this page covers vs related pages), Overview, Architecture sections with diagrams and tables, Related Pages, Changelog, Navigation footer.
API reference pages use this structure: Title, Quick Reference endpoint summary table, Per-endpoint sections (Request, Response, Errors), Related Pages, Changelog, Navigation footer.
Landing pages use HTML card grids to link to sub-sections, followed by a Quick Start path and high-level architecture diagram. No navigation footer.
Use these blockquote patterns consistently:
| Type | Syntax | When to Use |
|---|---|---|
| Note | > **Note**: ... |
General information the reader should know |
| Warning | > **Warning**: ... |
Something that could cause problems if ignored |
| Tip | > **Tip**: ... |
Helpful shortcut, not essential |
| Prerequisites | > **Prerequisites**: ... |
Required before starting. Links to other pages |
| Scope | > **Scope**: ... |
What this page covers vs doesn't. Links to related page |
| Draft | > **Draft**: ... |
Incomplete page, will be expanded |
## Related Pages section at the bottom (before navigation footer)| When Page Mentions... | Link To |
|---|---|
| "backend API" | Backend Overview |
| "authentication" | Auth Architecture |
| "payments/billing/Stripe" | Payments Architecture |
| "humanizer" (in non-humanizer page) | Humanizer Feature |
| "detector" (in non-detector page) | Detector Feature |
| "Redux/state management" | State Management |
| "API endpoint" (in feature page) | Corresponding API Reference page |
Every page (except landing pages) must end with a navigation line after a horizontal rule, containing Prev, Next, and Up links as applicable.
Every page must have tags from these categories:
| Category | Required | Tags |
|---|---|---|
| Component | Yes | web-app, mobile-app, chrome-plugin, shopify-plugin, wordpress-plugin, dev-portal, backend, ai-models, infrastructure |
| Domain | Yes | auth, payments, humanizer, detector, documents, i18n, monitoring, security |
| Content Type | Yes | setup-guide, architecture, api-reference, how-to, adr, troubleshooting, reference, template |
| Audience | Recommended | frontend-dev, backend-dev, mobile-dev, devops, new-hire, all-devs |
| Status | Recommended | draft, review-needed, current, outdated |
| Coding Style - TypeScript | TypeScript coding conventions |
| Coding Style - Python | Python coding conventions |
| API Design Guidelines | API conventions |
| Git Workflow | Branching and commit standards |
| Date | Author | Change |
|---|---|---|
| 2026-01-31 | Admin | Expanded with page templates, callouts, cross-linking rules, navigation footer |
| 2026-01-30 | Admin | Initial creation |
Prev: Testing Standards | Next: TypeScript Coding Standards | Up: General