Skip to content

Reorganize documentation for contributors vs consumers#17

Merged
agarcher merged 3 commits intomainfrom
docs
Jan 12, 2026
Merged

Reorganize documentation for contributors vs consumers#17
agarcher merged 3 commits intomainfrom
docs

Conversation

@agarcher
Copy link
Owner

@agarcher agarcher commented Jan 12, 2026

Summary

  • Add docs/ARCHITECTURE.md with design patterns and package structure extracted from IMPLEMENTATION_PLAN.md
  • Add CONTRIBUTING.md with build/test/release instructions for developers
  • Update README to focus on end users, with link to CONTRIBUTING.md
  • Remove outdated IMPLEMENTATION_PLAN.md and docs/RELEASE_TEST_PLAN.md

Test plan

  • Verify links in README and CONTRIBUTING.md work correctly
  • Review ARCHITECTURE.md for accuracy

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation

    • Added a comprehensive contributing guide, an architecture overview, and a maintainers guide; README now points to the contributing guide for development, build, test, and release instructions.
  • Chores

    • Removed outdated long-form implementation and release-test planning documents to consolidate and streamline project docs.

✏️ Tip: You can customize this high-level summary in your review settings.

- Add docs/ARCHITECTURE.md with design patterns and package structure
- Add CONTRIBUTING.md with build/test/release instructions
- Remove IMPLEMENTATION_PLAN.md (fully implemented, info preserved in ARCHITECTURE.md)
- Remove docs/RELEASE_TEST_PLAN.md (no longer needed)
- Update README to focus on end users, link to CONTRIBUTING.md

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@coderabbitai
Copy link

coderabbitai bot commented Jan 12, 2026

📝 Walkthrough

Walkthrough

Documentation reorganization: adds CONTRIBUTING.md, docs/ARCHITECTURE.md, and docs/MAINTAINERS.md; removes IMPLEMENTATION_PLAN.md and docs/RELEASE_TEST_PLAN.md; updates README.md to reference CONTRIBUTING.md instead of inline development instructions.

Changes

Cohort / File(s) Summary
Documentation additions
CONTRIBUTING.md, docs/ARCHITECTURE.md, docs/MAINTAINERS.md
New contributor guide, architecture doc with package layout and design patterns, and maintainers guide with merge/release workflows.
Documentation removals
IMPLEMENTATION_PLAN.md, docs/RELEASE_TEST_PLAN.md
Deleted a comprehensive implementation plan and a multi-phase release testing plan.
README update
README.md
Replaced the "Development" section with a "Contributing" pointer to CONTRIBUTING.md; removed inline build/test/release instructions.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 I hopped through docs both old and new,

Tidied paths and showed what to do.
CONTRIBUTING basks, ARCHITECTURE beams,
Plans retired like soft spring dreams. 🥕✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The pull request title accurately summarizes the main change: reorganizing documentation to separate contributor-focused content (CONTRIBUTING.md, docs/MAINTAINERS.md) from consumer-focused content (updated README with architectural details in docs/ARCHITECTURE.md).
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
  • 📝 Generate docstrings

Comment @coderabbitai help to get the list of available commands and usage tips.

agarcher and others added 2 commits January 11, 2026 20:54
- CONTRIBUTING.md: Remove redundant `wt cd` from example (create auto-navigates)
- CONTRIBUTING.md: Update git workflow to use forks instead of feature branches
- CONTRIBUTING.md: Remove releasing and code style sections
- Add docs/MAINTAINERS.md with release process and PR merge policy
- Remove Future Enhancements from ARCHITECTURE.md (covered in separate PR)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Add missing commands: cleanup, exit, root
- Remove non-existent "global" config
- Remove non-existent "pre_cleanup" hook
- Fix right border alignment

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
docs/ARCHITECTURE.md (1)

9-9: Consider adding language identifiers to code blocks.

The markdownlint tool flags that fenced code blocks should specify a language for proper syntax highlighting and accessibility. Consider adding identifiers:

  • Line 9: ```text for the ASCII diagram
  • Line 38: ```text for the directory structure
  • Line 77: ```bash for the shell command example
📝 Proposed fixes

Line 9:

-```
+```text
 ┌───────────────────────────────────────────────────────────┐

Line 38:

-```
+```text
 wt/

Line 77:

-```
+```bash
 -X github.com/agarcher/wt/internal/commands.Version=$(VERSION)

Based on static analysis hints (markdownlint-cli2).

Also applies to: 38-38, 77-77

📜 Review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5fc1650 and 8f27d30.

📒 Files selected for processing (3)
  • CONTRIBUTING.md
  • docs/ARCHITECTURE.md
  • docs/MAINTAINERS.md
✅ Files skipped from review due to trivial changes (1)
  • docs/MAINTAINERS.md
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
docs/ARCHITECTURE.md

9-9: Fenced code blocks should have a language specified

(MD040, fenced-code-language)


38-38: Fenced code blocks should have a language specified

(MD040, fenced-code-language)


77-77: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

🔇 Additional comments (2)
docs/ARCHITECTURE.md (1)

1-130: Excellent architecture documentation!

The document provides clear, comprehensive coverage of the tool's internal architecture with well-chosen examples. The explanations of design patterns (shell integration, repository detection, hook environment) are particularly helpful for contributors. The rationale for key decisions (Go, no direnv dependency) is well-articulated.

CONTRIBUTING.md (1)

1-56: Clear and practical contribution guide!

The setup and testing instructions are accurate and easy to follow. The PATH manipulation and shell integration commands are correct, and the example test workflow provides a practical way for contributors to verify their changes.

@agarcher agarcher merged commit 0650413 into main Jan 12, 2026
5 checks passed
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