Skip to content

Docs: reconcile the two documentation hubs and link the sample projects #234

Description

@Reefact

Problem

The README's Documentation section omits six English guides (OutcomeGuide, WritingErrorMessages, LoggingIntegration, TheHtmlRenderer, DocumentationExtractionReference, and DocumentationMap itself); DocumentationMap omits six others — most notably the 724-line RequestBinder guide — and is reachable from exactly one page footer. DocumentationMap.en.md:8 claims the README "lists every document by area", which is false. Worse: neither README nor GettingStarted nor DocumentationMap links either sample project — FirstClassErrors.Usage, the compiled, snapshot-tested realization of every guide's pattern, is linked from zero user documents.

Impact

The intent-based navigation the project built is invisible from the entry point, and its best teaching assets are undiscoverable from the documented reading path.

Direction

  • Add the six missing guides to the README's Documentation section and link DocumentationMap prominently; add the six missing guides (incl. RequestBinder) to DocumentationMap's intents; make the :8 claim true.
  • Add a "Runnable examples" pointer (README, GettingStarted, DocumentationMap) naming both Usage projects.
  • Optionally add a tools/-style inventory check: every for-users/*.en.md reachable from README or DocumentationMap.
  • FR twins in lockstep; also repair the three non-reciprocal prev/next footer links while in there.

Acceptance criteria

  • Every for-users guide is reachable from at least one hub; both samples are linked from the three entry pages; EN and FR updated together.

Context

Surfaced by the 2026-07-20 architecture, design & ecosystem audit (doc/handwritten/for-maintainers/audit/2026-07-20-firstclasserrors-architecture-and-design-audit.md, §11.2/§14-H1; branch claude/firstclasserrors-audit-83gap7).

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions