Skip to content

Tracking Issue: restructure PowerContext documentation #1226

Description

@PsiACE

Goal

Define a clear documentation layout and fill the current gaps.

User and developer documentation must reflect the current code and public
contracts. RFCs are frozen design records and may become outdated.

Proposed layout

The following layout is illustrative. File names and final page boundaries may
change during implementation.

docs/en/
├── index.md                         # Product landing page and main entry points
├── docs/                            # Current user-facing documentation
│   ├── index.md                     # Documentation overview and journey selection
│   ├── tutorials/                   # Guided learning journeys with working outcomes
│   │   ├── codex-quickstart.md
│   │   └── ...
│   ├── how-to/                      # Steps for completing specific tasks
│   │   ├── install-and-run.md
│   │   └── ...
│   ├── explanation/                 # Concepts, boundaries, and system behavior
│   │   ├── core-concepts.md
│   │   └── ...
│   └── reference/                   # Current interfaces, configuration, and contracts
│       ├── interfaces.md
│       └── ...
├── development/                     # Current implementation and extension guidance
│   ├── core-protocol.md
│   └── ...
├── rfcs/                            # Frozen design records
├── blog/                            # Published engineering notes
└── changelog/                       # User-visible release changes

Keep docs/zh/ structurally equivalent.

Tracking

  • Confirm the layout and classify existing pages.
  • Add the missing explanation pages.
  • Separate Memory and Handoff terminology and workflows.
  • Document current Handoff, Review, Experience, Skill, and Report behavior.
  • Move procedures out of reference pages.
  • Audit docs against code, OpenAPI, CLI, Client, and MCP.
  • Fix RFC navigation and release information.
  • Keep English and Chinese navigation synchronized.
  • Ensure make docs-test passes.

Documentation quality

Keep pages short, scannable, and suitable for human readers. When a page covers
a workflow, state the steps and expected outcome clearly. If AI helps draft a
page, use the documentation-writer and humanizer skills, then have a human
verify and approve the result.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    Status
    Todo

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions