Skip to content

docs: restructure the README for evaluators, operators and contributors - #155

Merged
timeleft-- merged 1 commit into
mainfrom
automation/fava-trails.org-35-readme
Oct 24, 2026
Merged

timeleft-- merged 1 commit into
mainfrom
automation/fava-trails.org-35-readme

Conversation

@yia-mw-agent

Copy link
Copy Markdown
Contributor

Refs MachineWisdomAI/fava-trails.org#35 (companion to the website PR; this PR must merge first because the website links to the README anchors added here).

What changed

  • README.md is replaced with the accepted evaluator package (Part D, source package SHA-256 c1f6858bc4d34d4fe6f0d133b63d5a6dc9e453eb3933f6a74c8a5cdeeb09ad2d, BEGIN/END markers excluded). It opens with purpose, Fit and limits, how it works and install, then separate Operating and Contributing sections. Release news and the 0.7.0 release-status box are gone from the reader path; release history stays in CHANGELOG.md and docs/releases/.
  • New README anchors the website links to: #fit-and-limits, #client-registration-examples, #remove-empty-scaffolding-scopes, #quick-start.
  • Candidate evidence boundary stated once in Install: the walkthrough was recorded on an installed 0.9.0rc1 candidate; source is 0.9.1rc1 and unpublished. Final release wording stays with chore(deps): Bump cryptography from 46.0.5 to 46.0.6 in the uv group across 1 directory #38.
  • docs/fava_trails_faq.md and docs/fava_trails_onepager.html: historical banners only. Bodies and paths are unchanged.
  • Keeping documentation in step with the moved README sections: AGENTS_SETUP_INSTRUCTIONS.md link README.md#register-the-mcp-server now points to #quick-start (the old anchor no longer exists); docs/documentation-ownership.md and docs/blueprint-maintenance.md use the new README section names ("Choose a reviewer", "fit-and-limits").

Verification

  • Every relative link and in-page anchor in the new README resolves against this tree (script check, no misses), including AGENTS_SETUP_INSTRUCTIONS.md#pushing-to-remote and #lifecycle-hooks, the Blueprint files and docs/releases/.
  • python3 scripts/mw-version.py check --base origin/main: passes, docs-only, no bump (source stays 0.9.1rc1).
  • No code or test change. The test suite does not read the README.

Reviewer notes

  • Operator detail that left the README now lives only in its owner document: tunnel /healthz, preflight and --sync-on-start (docs/secure-mcp-tunnel.md), and the uv run --directory selector (docs/runtime-and-upgrade.md). The old README's detailed description of fava-trails register --write --verify diagnostics (backup, mode cap, inspector_config_load) is not restated in another document. The new README keeps what the flags do in one sentence. Say so if you want a short owner section for it.
  • Not in this PR (accepted carry-forwards): the stale "currently resolves published 0.6.0" line in AGENTS_SETUP_INSTRUCTIONS.md and the one-pager footer stamp (the footer stays as visible evidence of the release it describes).
  • No tag, package publication or live MCP change.

Replace the README with an evaluator-first route (purpose, fit and limits,
how it works, install, quick start, reviewer choice, sharing) with separate
operator and contributor sections, and keep procedures in their owning
documents. Update the README section names in the ownership map, repair the
setup guide's README anchor, and mark the FAQ and the September 2026
one-pager as historical background.

@timeleft-- timeleft-- left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Independent Captain review of exact head 34d8c2e: all six changed files read. Replacement README matches the separately accepted canonical evaluator package exactly (SHA c1f6858bc4d34d4fe6f0d133b63d5a6dc9e453eb3933f6a74c8a5cdeeb09ad2d); historical banners and bounded incoming-owner link updates preserve source fidelity and release history. Independent version-policy check passes with actual PR title, docs-only 0.9.1rc1 unchanged. Prior canonical instruction syntax, relative-path/anchor and source review apply to the identical payload. Clean source review; merge still requires all current-head required hosted checks and fresh base. No package publication or live deployment acceptance is implied.

@timeleft--
timeleft-- merged commit f772243 into main Oct 24, 2026
12 checks passed
@timeleft--
timeleft-- deleted the automation/fava-trails.org-35-readme branch October 24, 2026 23:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants