Lean README + CONFIGURATION.md split, demo polish (SF Mono, model switch) - #7
Merged
Merged
Conversation
README is now a 60-line landing page focused on first install: - 3-step install with the local model - the five glyphs - 5 example commands worth knowing - one link to CONFIGURATION.md for everything else CONFIGURATION.md (new) carries the deep reference content that used to bloat the README: tier table, sessions, terminal-context ladder, semantic recall, claude-mem, hard wall, full env-var table, hosted-API setup, JS rendering, what's not built. AGENTS.md gains a contributor quickstart at the top (clone → venv → test → ruff). It already covered the load-bearing invariants well. Demo polish: - Font swapped to SF Mono so the gif matches macOS Terminal/iTerm defaults out of the box. - Failed command upgraded from `gti status` (one-letter swap, too obvious) to `git log --oneline -n 10 --grpe 'fix'` — the kind of flag typo a developer actually makes mid-flow. - Per-call model routing showcased explicitly: `, --fast`, `,, --fast`, `? --fast` for the cheap turns; `? --balanced` for the harder diagnosis of the piped Python traceback. The visible tier flags make the side-by-side routing pillar self-explanatory. - `,,` zsh function now accepts a leading tier flag, so `,, --fast` routes the fix call (it was previously eaten by the ctx/fix switch). - Both tiers warmed in the hidden setup to remove cold-start jitter. 257 tests still pass; ruff clean.
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.
Summary
Docs
README.mdis now ~70 lines: a clean landing page focused on first install — 3 steps with the local model, the five glyphs, and 5 example moves worth knowing. Everything else is one link out.CONFIGURATION.md(new) carries the deep reference that used to bloat the README: model tiers, sessions, terminal-context ladder, semantic recall, claude-mem, the hard wall, the full env-var table, hosted-API setup, JS rendering, what's deliberately not built.AGENTS.mdgains a contributor quickstart at the top (clone → venv → test → ruff).Demo polish
gti status(one-letter swap, too obviously a setup) togit log --oneline -n 10 --grpe 'fix'— the kind of flag typo a developer actually makes mid-flow., --fast,,, --fast,? --fastfor the cheap turns;? --balancedfor the harder diagnosis of the piped Python traceback. The visible tier flags make the side-by-side routing pillar self-explanatory without needing the docs.,,zsh function now accepts a leading tier flag so,, --fastroutes the fix call (previously the flag was eaten by the ctx-vs-fix switch).Test plan