Repository navigation
README: an overview and quick start; the reference detail moves to docs - #195
Merged
Merged
Conversation
The README was one long reference page: a first-time reader met the whole install footprint, seven tuning inputs and the sandbox limits before learning how to try Factory. It is now a short overview: what Factory does in five steps, what to know before starting (it merges on its own, it spends money, what the agent can touch), a four-step quick start, what it adds to a repository, and a map of the docs. Nothing is dropped. docs/INSTALL.md takes the install footprint, the routes, setup by hand, the cost inputs, upgrade and uninstall; docs/USAGE.md takes writing an Objective, what the issue shows, Blocked and Question, and the commands. CONTRIBUTING.md says what helps in a bug report. AGENTS.md maps the new pages and keeps the README short. Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01CS53Gu2D3bE8mKgFN92XP5
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.
The README was one long reference page. A first-time reader met the whole install footprint, seven tuning inputs and the cloud sandbox's session limits before learning how to try Factory.
What guided the rewrite:
The new README (148 lines):
/factory:setup,/factory:doctor, file an issue (with an example issue). Then the same setup as scripts, and local mode as a way to try it first.Nothing is dropped; the reference detail moves:
docs/INSTALL.md(new): requirements, the three routes, the install footprint table, what each credential can do, setup by hand (including creating the App), check and run, the cost inputs as a table, upgrade and uninstall.docs/USAGE.md(new): writing an Objective, what the issue shows during a run, Blocked and Question and how to answer, auto-merge, siblings, one repository per Objective, and the commands.CONTRIBUTING.md: says what helps in a bug report. The no-outside-PRs rule is unchanged.AGENTS.md: maps the two new pages and says the README stays a short overview.Checked:
docs/USAGE.mdwere checked against the code: the acceptance headings, priority order, who may file, and the six-part limit.doctor.test.mjsstill finds the App's permission list in the README.🤖 Generated with Claude Code
https://claude.ai/code/session_01CS53Gu2D3bE8mKgFN92XP5