Maintaining this guide

Documentation is part of the change

Keep this guide current in the same change as the implementation. The root AGENTS.md makes this a standing repository requirement. Update the topic that explains the changed behavior rather than appending a chronological note that leaves the original explanation wrong. If a change has no developer-facing effect, no prose edit is necessary; state that assessment in the change description.

Update workflow

1. Trace the active implementation and review the relevant topic before editing code. Read applicable repository skills and C# standards when required.
2. Update behavior, prerequisites, failure cases, compatibility constraints, and source references alongside the implementation. Avoid copying secrets or large configuration snapshots.
3. When adding a topic, assign a new unique explicit slug in docs/toc.json, add its source-browser URL and renderer settings, link it from the developer landing page, and add the file to the root solution's Docs / Developer solution folder.
4. Validate TOC JSON, unique slugs, source-file existence, internal links against public slugs, image references, and source-browser target paths. Set settings.useDiagramsMermaid on topics with diagrams.
5. Compare existing route mappings and headings/anchors before and after the edit. Retain compatible explicit anchors if a heading must change. Preserve all existing public paths, casing, spelling, and significant punctuation; use a new destination for a new topic. Only change public URLs when explicitly requested, retaining a supported alias/redirect where possible.
6. Review the diff and report what was verified. A source check does not establish rendered or published correctness.

Navigation and publication

docs/toc.json is the authoritative navigation manifest for these documentation sources. Its Developer documentation node includes this guide. Topic link values are relative source filenames; slug values are independent public URLs. Do not rename files or infer a URL hierarchy from folder names. Existing specification routes remain unchanged.

The full docs directory is the publishing unit: include the TOC, Markdown sources, and referenced assets. A Lorekeeper host must honor explicit slugs, source paths, topic Mermaid settings, and relative image serving. No publication host or renderer has been configured as part of the initial guide. Validate a hosted preview before declaring the guide published; do not create a second competing TOC or edit generated site copies.

For local browsing in an IDE, use Docs / Developer in CODE.com.sln. Public-slug links require a documentation host; open the corresponding source file locally when no host is available.

Screenshots and diagrams

Prefer diagrams for request/data flow and screenshots for behavior a developer must recognize visually. Capture screenshots from a known local/test environment and record the route, SiteMode, StyleMode, viewport, capture date, and relevant state. Exclude personal information, credentials, and payment data. Store captures under docs/Developer/images, reference them with relative Markdown paths, and include them in the solution and publication assets. Refresh or remove screenshots when the described behavior changes.

The guide uses Mermaid architecture/reader diagrams, running-site screenshots in the Presentation and Accounts topics, and links to the existing specification's desktop/mobile design images. Keep actual captures distinct from design references. Current captures cover the 2027 home/magazine layout, article opening, reading settings, code section, and the empty password-change dialog. The account image is cropped to exclude personal information; no password change was submitted. Do not replace source-based explanations with screenshots alone.

Source references

• Repository instructions
• Documentation manifest
• Root solution