Skip to content

Simplify project documentation - #430

Merged
powerfooI merged 2 commits into
mainfrom
simplify-docs
Oct 16, 2026
Merged

powerfooI merged 2 commits into
mainfrom
simplify-docs

Conversation

@powerfooI

Copy link
Copy Markdown
Owner

Summary

  • Rewrite README, FEATURES, SECURITY, CONTRIBUTING, and the docs/ guides (DEPLOYMENT, ARCHITECTURE, TUTORIAL, SCREENSHOTS, HISTORY) to roughly half their length (~4,000 → ~2,200 lines).
  • Condense the Ranger sections in FEATURES, DEPLOYMENT, and ARCHITECTURE in particular (~625 → ~80 lines).
  • Keep user-facing behavior, configuration, security, migration, and data-loss guidance; drop implementation detail that duplicates the code.
  • Keep every anchor referenced by the app (WorktreeHooksDialog), CLI hints (doctor, service-manager), git-snapshot.ts, and the Pages site; keep the tutorial's five chapters and anchors.
  • Fix the stale web/src/styles.css reference in .github/copilot-instructions.md.

Verification

  • Script check: every relative link and anchor in all Markdown files resolves
  • bun test scripts/ (93 pass, 1 skip)
  • bun run build:site
  • Pre-commit hook (lint, bun check)

🤖 Generated with Claude Code

Rewrite README, FEATURES, SECURITY, CONTRIBUTING, and the docs/ guides to
roughly half their length. Keep user-facing behavior, configuration,
security, migration, and data-loss guidance; drop implementation detail
that duplicates the code. Condense the Ranger sections in particular, and
keep every anchor referenced by the app, CLI hints, and Pages site.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@powerfooI powerfooI added the documentation Improvements or additions to documentation label Oct 16, 2026
@powerfooI

Copy link
Copy Markdown
Owner Author

@codex review

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 16, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-16T07:41:57.257414Z 327b4a8 Manual request
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 327b4a8d69

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread docs/DEPLOYMENT.md Outdated
Comment thread FEATURES.md Outdated
Comment thread README.md Outdated
Restore the foreground-process caveat for connection edits, describe OSC 52
delivery by foreground recipient rather than source pane, and qualify the
login requirement with the loopback development exception.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@powerfooI
powerfooI merged commit 9e9db49 into main Oct 16, 2026
4 checks passed
@powerfooI
powerfooI deleted the simplify-docs branch October 16, 2026 07:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant