Skip to content

Wiki Structure

flazouh edited this page Apr 20, 2026 · 2 revisions

Wiki Structure

The Acepe wiki should be a portal, not a second competing architecture authority.

Recommended structure

Page Job
Home Top-level portal and fastest entrypoint
Architecture-Concepts Reading order into the core architecture docs
Wiki-Structure Explain how the wiki and repo docs relate

Source-of-truth rule

%%{init: {'theme':'base','themeVariables':{'primaryTextColor':'#1f2937','primaryBorderColor':'#9ca3af','lineColor':'#6b7280','tertiaryColor':'#ffffff','background':'#ffffff'}}}%%
flowchart LR
    wiki["Wiki portal"] --> repo["Versioned repo docs"]
    repo --> code["Code changes / PRs"]

    classDef blue fill:#B4D2F0,stroke:#6b7280,color:#1f2937;
    classDef green fill:#B4E6C8,stroke:#6b7280,color:#1f2937;
    classDef yellow fill:#FFEBB4,stroke:#6b7280,color:#1f2937;
    classDef orange fill:#FFD2AA,stroke:#6b7280,color:#1f2937;
    classDef purple fill:#D2BEF0,stroke:#6b7280,color:#1f2937;
    classDef gray fill:#DCDCE1,stroke:#6b7280,color:#1f2937;

    class wiki yellow;
    class repo purple;
    class code green;
Loading

What belongs where

Belongs in wiki Belongs in repo docs
Navigation Canonical architecture intent
Reading guides Ownership rules and invariants
Entry pages and doc map Domain model definitions
Pointers to deeper docs Versioned examples tied to code

Rule of thumb

If a statement should be updated in the same pull request as a code change, it probably belongs in docs/concepts/ inside the repo, not only in the wiki.

Clone this wiki locally