docs: restructure README into a concise overview plus docs/ tree (#82) - #9
Merged
Merged
Conversation
…chenguid#82) Port upstream kunchenguid#82, adapted to the herdr fork. Trim the README from 233 to ~143 lines by relocating reference material into a new docs/ tree, with no info loss. - docs/architecture.md: the How It Works internals (event-driven supervision, away-mode, worktrees, task shapes, project modes, secondmates incl. the spawn-time local-HEAD sync, project memory, fleet sync, self-update, restart). - docs/configuration.md: AGENTS.md, the tasks-axi backend, captain prefs, secondmate routes, FM_HOME, harness support, and the full env-var reference (now including FM_SEND_SETTLE and FM_MAX_DEFER_SECS). - docs/scripts.md: the bin/ toolbelt table (now lists fm-ff-lib, fm-tangle-lib, fm-tasks-axi-lib, fm-backend). - README: tightened How It Works to diagram + synopsis, added a Documentation section linking the tree, noted the agent-only reference skills, and a Contributing section. - CONTRIBUTING: folded in the Development/dev-test block from the README. - docs/ added to the tracked shared-material lists (AGENTS.md, CONTRIBUTING) and the layout map. Docs-only; shellcheck clean, full suite green (88 checks), all internal links resolve.
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
1 participant
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.
Final PR of the upstream-port series — the second half of the doc restructure (kunchenguid#82). Docs-only.
Trims the README from 233 → ~143 lines by relocating reference material into a new
docs/tree, with no information loss.What
docs/architecture.md— the "How It Works" internals: event-driven supervision, away-mode, worktrees, the two task shapes, project modes, secondmates (incl. the new spawn-time local-HEAD sync from feat: sync secondmate homes to primary local head kunchenguid/firstmate#91), project memory, fleet sync, self-update, restart-proofing.docs/configuration.md—AGENTS.md, thetasks-axibackend, captain prefs, secondmate routes,FM_HOME, harness support, and the full env-var reference (now includingFM_SEND_SETTLEandFM_MAX_DEFER_SECS).docs/scripts.md— thebin/toolbelt table (now listsfm-ff-lib,fm-tangle-lib,fm-tasks-axi-lib,fm-backend).docs/added to the tracked shared-material lists (AGENTS.md §1, CONTRIBUTING) and the §2 layout map.Validation
shellcheck bin/*.sh tests/*.shclean; full suite green (88 checks); all internal doc links resolve.This completes the port of all six new upstream commits (kunchenguid#79, kunchenguid#80-skipped, kunchenguid#82, kunchenguid#83, kunchenguid#88, kunchenguid#91) onto the herdr fork.