docs: reorganize README into a docs/ guide with a table of contents - #26
Merged
Conversation
The README had grown into a single ~530-line page covering installation, every command, and all configuration. Split it into a focused landing page plus a structured docs/ folder: - README.md is now a slim landing page: highlights, installation, a quick start, the command table, and links into docs/. - docs/README.md is the documentation index (table of contents) with a per-command reference table. - One page per topic: getting-started, commands, workspaces, pull-requests, onboarding, shell-integration, configuration, and skills. Each page has its own contents and prev/next navigation. Content is reorganized and expanded (a Getting Started workflow, concept intros, cross-links) without changing documented behavior. All internal links and anchors were validated.
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
The README had grown into a single ~530-line page covering installation, every command, and all configuration. This PR splits it into a focused landing page plus a structured
docs/folder with a table of contents and one page per topic — easier to scan, navigate, and maintain.Created in a fresh workspace via
gx workspace new docs/restructure(dogfooding).What changed
README.md→ slim landing page (528 → 99 lines)docs/, development, and license.New
docs/folder (9 pages, ~880 lines)docs/README.md— documentation index / table of contents + a per-command reference table.getting-started.md— prerequisites, install, shell integration, and a first end-to-end workflow.commands.md—checkout,status,add,commit,push,stash,log, and git pass-through.workspaces.md— worktree concepts, create/switch/update/remove,setupvssync, utility commands, the cleanup lifecycle + safety, the TUI, andcd-on-switch.pull-requests.md— the PR dashboard.onboarding.md— shared vs. personal config, the.gx/workspace.tomlschema, hooks, and layering.shell-integration.md—gx setup.configuration.md— theconfig.tomlreference.skills.md— agent skills.Notes
Testing
Docs-only change; no source touched.