Skip to content

CI-048 - Improve Documentation Navigation And Public Release Guidance

Summary

Apply the documentation cleanup recommended by the two technical doc reviewers and product reviewer. The goal is to keep current operator guidance runnable, make public-facing documentation easier to enter, and separate product story from engineering ledger material.

Scope

  • Fix stale current-doc paths and branding in repo entry points.
  • Make release and campaign commands clearly runnable from the build orchestrator checkout.
  • Improve MkDocs navigation for the current release plan and user/developer entry paths.
  • Add concise public release-note and REST quickstart entry points.

Non-Goals

  • Do not rewrite historical provenance docs.
  • Do not change release gates, package contents, or API behavior.
  • Do not split the full active backlog ledger in this slice.

Acceptance Criteria

  • [x] Current docs no longer point routine readers at eMule-main.
  • [x] Release/operator command docs identify the required repos\emulebb-build working directory.
  • [x] Current release execution plan is discoverable from MkDocs navigation.
  • [x] User-facing docs expose release notes and REST quickstart entry points.
  • [x] Documentation validation passes.

Closure Evidence

Landed on emulebb-tooling/main:

  • 6d5c9df CI-048 fix runnable doc entrypoints
  • cfea326 CI-048 improve docs navigation
  • d68068c CI-048 add release and REST quickstarts
  • d65f979 CI-048 clarify roadmap and branch guidance

Validation used for each implementation slice:

  • git diff --check
  • python scripts\docs-item-taxonomy-check.py
  • python scripts\docs-structure-check.py --fail-on-wide-tables
  • python scripts\github-roadmap-check.py