Skip to content

docs: document versioned workspaces, tool scoping, and missing commands - #6

Merged
stevenzg merged 3 commits into
mainfrom
claude/tarjan-up-version-control-r8166c
Jul 17, 2026
Merged

docs: document versioned workspaces, tool scoping, and missing commands#6
stevenzg merged 3 commits into
mainfrom
claude/tarjan-up-version-control-r8166c

Conversation

@stevenzg

@stevenzg stevenzg commented Jul 17, 2026

Copy link
Copy Markdown
Owner

Summary

Brings the docs in line with the current code, centred on how tarjan up manages versioned workspaces — plus a light-mode legibility fix for the landing page:

  • Website was behind the README. Quickstart only described fresh timestamped workspaces; the command reference was missing tarjan pull and tarjan upgrade entirely, and --version / --ai / positional up [service...] were absent from the flag list. Quickstart, commands, and configuration are now up to date, including a new "Workspaces & versions" section on the configuration page.
  • Parallel-run limitation is now explicit. Both README and website say that parallel version workspaces (--version feat-a / --version feat-b) coexist on disk but cannot run simultaneously — services publish fixed host ports shared by every workspace, and the already-running preflight only guards re-up of the same workspace. Documented the down-then-up switch flow (fast thanks to clone/setup reuse).
  • Service-scoped tool checks documented. The recently added requires[].services field and tarjan doctor <service...> scoping are now covered in the README tool reference, the configuration page, and CHANGELOG.md.
  • Landing page light-mode fix. The landing page hardcoded dark-canvas colors (text-white/60, border-white/10, …) while the layout pinned the theme to dark — but the docs' theme toggle persists via next-themes, so switching to light left white text on a white background. The page is now theme-aware (neutral colors by default, original palette under dark:, terminal/config panes stay dark in both themes), with the dark: variant driven by the theme class instead of prefers-color-scheme. Verified both themes (landing + docs) with a static build and Playwright screenshots.
  • One drive-by gofmt fix in internal/config/config_test.go so make check's fmt gate passes.

Type of change

  • Bug fix (fix)
  • New feature (feat)
  • Refactor / cleanup (refactor / chore)
  • Docs (docs)
  • CI / build (ci / build)

Checklist

  • make check passes locally (fmt, vet, lint, race tests + coverage gate).
  • Added or updated tests for the change. (docs + presentation only; no Go behavior change)
  • Updated CHANGELOG.md under ## [Unreleased] (if user-visible).
  • Commits follow Conventional Commits.
  • Touched OS-specific code? Verified the cross-compile matrix builds. (none touched)

Notes for reviewers

  • The "Workspaces & versions" anchor is linked from quickstart and the commands page (/docs/configuration#workspaces--versions).
  • The CHANGELOG also gains an entry for the already-merged service-scoped tool checks (2998ab5), which landed without one.
  • @custom-variant dark in globals.css makes Tailwind's dark: utilities class-driven, matching how the fumadocs theme provider toggles <html class="dark">.

🤖 Generated with Claude Code

https://claude.ai/code/session_01EAYGh5BQL2UZgbP2jMLYPs

claude added 3 commits July 17, 2026 03:55
The named-workspace mechanism (`version:` / `up --version`) was documented in
the README but absent from the website docs: quickstart only described fresh
timestamped workspaces, the command reference lacked `tarjan pull` and `tarjan
upgrade` entirely, and `--version` / `--ai` were missing from the `up` flag
list.

Bring the website up to date (quickstart, commands, configuration — including a
new "Workspaces & versions" section), and state explicitly in both README and
website that parallel version workspaces coexist on disk but cannot RUN
simultaneously, since services publish fixed host ports that every workspace
shares — the existing already-running guard only covers re-`up` of the same
workspace.

Also document the service-scoped tool checks (`requires[].services`,
`tarjan doctor <service>`) in the README tool reference, the configuration
page, and the changelog.
The landing page hardcodes dark-canvas colors (text-white/60,
border-white/10, ...) while the root layout pins theme to dark. But the
docs pages expose a theme toggle, and next-themes persists the choice —
switch to light in the docs and the landing page loses its .dark class,
leaving white text on a white background.

Make the page properly theme-aware: neutral dark-on-light colors by
default with the original white-on-dark palette under dark:, keep the
terminal/config panes dark in both themes, and drive the dark: variant
from the theme class (@custom-variant) instead of prefers-color-scheme so
it follows the toggle. Drop the hardcoded dark class on <html> — the
provider owns it.

Verified both themes render legibly (landing + docs) via a static build
and Playwright screenshots.
@stevenzg
stevenzg merged commit c00bf40 into main Jul 17, 2026
6 checks passed
@stevenzg
stevenzg deleted the claude/tarjan-up-version-control-r8166c branch July 17, 2026 06:47
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.

2 participants