Skip to content

docs(readme): onboarding-first restructure; gitignore .envrc#63

Merged
manoldonev merged 1 commit into
mainfrom
docs/readme-onboarding-first
Jul 12, 2026
Merged

docs(readme): onboarding-first restructure; gitignore .envrc#63
manoldonev merged 1 commit into
mainfrom
docs/readme-onboarding-first

Conversation

@manoldonev

Copy link
Copy Markdown
Owner

Summary

README optimized for onboarding as the primary reading goal:

  • "Get started" moves ahead of "Why" and "Plugins" — a newcomer hits the install path in the first screenful.
  • Concrete onboard trigger: numbered steps separate the shell commands (claude plugin marketplace add / claude plugin install / cd repo && claude) from the in-session /second-shift:onboard invocation, so it's unambiguous where each is typed. The old block mixed shell commands and a slash command in one fence.
  • /dev-pipeline:run <ticket> gets its own fenced block as the explicit first-run step.
  • Requirements sentence tightened: the format: null/prettier edge case moved out of first contact (it lives in docs/onboarding.md); tracker-specific extras split into their own sentence.
  • Collaborator-pinning line now says commit the settings pin onboard writes instead of implying a manual pinning step; the restart instruction carries its rationale (plugin registration happens at session start).
  • "Why", "Plugins", "How it stays generic", "Design principles", "Docs": content unchanged, reordered only.

Also gitignores .envrc — the per-machine direnv env used to export OTel telemetry for the dev-pipeline cost block (local-only, opt-in per engineer; see the dev-pipeline plugin's cost-tracking-setup.md).

Opened as draft for eyes-on review of the new reading order.

🤖 Generated with Claude Code

Move Get started ahead of Why/Plugins and make the onboard trigger
concrete: numbered shell steps separated from the in-session
/second-shift:onboard invocation, /dev-pipeline:run as its own fenced
first-run step, requirements tightened, collaborator-pin line now says
'commit the pin onboard writes'. Also gitignore .envrc (per-machine
direnv env for OTel cost-tracking export — local-only, opt-in).

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@manoldonev
manoldonev marked this pull request as ready for review July 12, 2026 21:43
@manoldonev
manoldonev merged commit bdf6b46 into main Jul 12, 2026
2 checks passed
@manoldonev
manoldonev deleted the docs/readme-onboarding-first branch July 12, 2026 21:45
manoldonev added a commit that referenced this pull request Jul 13, 2026
Consume versions on merge for the v2.2.0 marketplace release. Content since
v2.1.8 (dev-pipeline 2.1.8→2.2.5, review-toolkit 2.1.2→2.1.3, intake-toolkit
2.0.0→2.0.1, second-shift 1.3.1→1.4.0) was already bumped per-PR; this commit:

- strips the "(in progress)" marker from the v2.2.0 CHANGELOG heading
- adds CHANGELOG coverage for the repo-local chores #66/#63/#80 (not shipped)
- sets metadata.version 2.1.8 → 2.2.0
- refreshes the docs/onboarding.md settings-pin example to v2.2.0

Trace-gate scrub (the hardened gate flagged content introduced this window):
- untrack .claude/second-shift.config.json (this repo's own dogfooding config
  carries real bot/app identifiers) and gitignore it — same per-machine class as
  the already-ignored .claude/audit, .claude/pipeline-state, .claude/worktrees,
  .envrc; the working copy stays local for self-consumption runs
- reword a "lineage" false-positive in docs/plans/acme-59.md

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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