Split the README into a front page and eight guides - #109
Merged
Merged
Conversation
The README had grown to 2,324 lines, and about 1,000 of them were maintainer notes: code signing alone ran to 479. A visitor met a `brew install` line before anything had said what GitWarren is. The front page now answers what it is, shows the screenshot, then installs, then points at the guides. Everything else moves to docs/ unchanged — reviews, agent access, the CLI, remote hosts, architecture, development, releasing and known limitations — with the cross-references repointed. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Two changes landed on main while this branch was open, both in parts of the README that had moved: - The five badges go at the top of the new front page, under the title. - The "In a container" rewrite — Glama builds from its admin page, not from our Dockerfile — lands in docs/agents.md, where that section now lives. Its pointer to docs/glama-build-spec.md became a real link now that both files sit in docs/. The new docs/glama-build-spec.md is listed in the README's documentation table so it stays a complete map of docs/. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
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.
The README had grown to 2,324 lines. About 1,000 of them were maintainer notes
nobody needs to use GitWarren or send a patch — code signing alone ran to 479 —
and a visitor met a
brew installline before anything had said what GitWarrenis.
The front page
185 lines, in the order a stranger needs them:
The guides
Moved verbatim into
docs/, by line range rather than retyped, so the prose isbyte-for-byte what it was:
docs/reviews.mddocs/agents.mddocs/cli.mdgitwarrencommand linedocs/remote-hosts.mddocs/architecture.mddocs/development.mddocs/releasing.mddocs/limitations.mdHeadings were promoted a level (skipping fenced blocks, so
# 1. Bump the versionin the release script stayed a shell comment).Cross-references
Everything that pointed into the old README was repointed: relative paths
gained
../now that they sit a directory down,CONTRIBUTING.md's fiveREADME anchors, and two comments in
electron-builder.yml. Two "see above"references that no longer had anything above them became real links.
Checks
over are the replaced
## Contentslist, headings that changed level, andlinks rewritten to cross files.
docs/arch.pnginlimitations.md, is the literal example of therepo-relative image syntax that deliberately isn't rendered.
electron-builder.ymlchanges are comment-only.🤖 Generated with Claude Code