Repository navigation
docs: lean README, docs/ folder, install-first recipe - #29
Merged
Merged
Conversation
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.
Makes the README a short first impression and moves the reference material into
docs/.README: 324 lines down to 66: pitch, screenshot, highlights, quick install, and a Docs index.
docs/: new pages for install, cli, keys, config, handoff, bstack, shep, review and development, plus an index in
docs/README.md. Stale facts in the existingdocs/bstack/guide andherdr-agents-subagents.mdwere checked against the current code and fixed (for example, the stage argv in handoff). Each fact now lives in one place.bercail/RECIPE.md (the herdr.dev first-run path): an agent that follows "add this layout" is now told to install bercail first (after asking the person), not just copy the layout files. A new "After the install" section points to Shep, the essential keys,
bercail doctorandbercail bstack status. The recipe's intro is now the GitHub repo description, andpreview.pngis the README screenshot, so the herdr.dev card shows it too.Checks: 0 broken links out of 100 relative links, recipe keys match
keys.json,herdr-app checkpasses for both mods, and all 25 tests pass. Docs only, no code changes. Thedocs/README.mdlink from the recipe will 404 on GitHub until this merges.Not tested: a real install from the herdr.dev prompt with a fresh agent.