Skip to content

docs: reorganize README into a docs/ guide with a table of contents - #26

Merged
reckerp merged 1 commit into
mainfrom
docs/restructure
Jun 29, 2026
Merged

docs: reorganize README into a docs/ guide with a table of contents#26
reckerp merged 1 commit into
mainfrom
docs/restructure

Conversation

@reckerp

@reckerp reckerp commented Jun 29, 2026

Copy link
Copy Markdown
Owner

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)

  • Highlights, installation, a runnable Quick start, the command table, a Documentation section linking into 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.mdcheckout, status, add, commit, push, stash, log, and git pass-through.
  • workspaces.md — worktree concepts, create/switch/update/remove, setup vs sync, utility commands, the cleanup lifecycle + safety, the TUI, and cd-on-switch.
  • pull-requests.md — the PR dashboard.
  • onboarding.md — shared vs. personal config, the .gx/workspace.toml schema, hooks, and layering.
  • shell-integration.mdgx setup.
  • configuration.md — the config.toml reference.
  • skills.md — agent skills.

Notes

  • No documented behavior changed. Existing content was reorganized and lightly expanded (concept intros, a Getting Started workflow, cross-links, and per-page prev/next navigation). No new features were invented.
  • Each page links back to the index and to the next topic.
  • All internal links and anchors were validated with a script (10 files, every relative link + heading anchor resolves).

Testing

Docs-only change; no source touched.

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.
@reckerp
reckerp merged commit 1d3c13e into main Jun 29, 2026
6 checks passed
@reckerp
reckerp deleted the docs/restructure branch June 29, 2026 20:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant