Repository navigation
docs: restructure the README for evaluators, operators and contributors - #155
Merged
Merged
Conversation
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--
approved these changes
Oct 24, 2026
timeleft--
left a comment
Member
There was a problem hiding this comment.
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.mdis replaced with the accepted evaluator package (Part D, source package SHA-256c1f6858bc4d34d4fe6f0d133b63d5a6dc9e453eb3933f6a74c8a5cdeeb09ad2d, 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 inCHANGELOG.mdanddocs/releases/.#fit-and-limits,#client-registration-examples,#remove-empty-scaffolding-scopes,#quick-start.docs/fava_trails_faq.mdanddocs/fava_trails_onepager.html: historical banners only. Bodies and paths are unchanged.AGENTS_SETUP_INSTRUCTIONS.mdlinkREADME.md#register-the-mcp-servernow points to#quick-start(the old anchor no longer exists);docs/documentation-ownership.mdanddocs/blueprint-maintenance.mduse the new README section names ("Choose a reviewer", "fit-and-limits").Verification
AGENTS_SETUP_INSTRUCTIONS.md#pushing-to-remoteand#lifecycle-hooks, the Blueprint files anddocs/releases/.python3 scripts/mw-version.py check --base origin/main: passes, docs-only, no bump (source stays 0.9.1rc1).Reviewer notes
/healthz,preflightand--sync-on-start(docs/secure-mcp-tunnel.md), and theuv run --directoryselector (docs/runtime-and-upgrade.md). The old README's detailed description offava-trails register --write --verifydiagnostics (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.AGENTS_SETUP_INSTRUCTIONS.mdand the one-pager footer stamp (the footer stays as visible evidence of the release it describes).