Clean up root directory, modernize README

[jordanpartridge]

Summary

Reorganized project structure for a cleaner, more professional root directory.

Changes

Moved to /docs:

• ARCHITECTURE.md
• COMMENT_FILTERING.md
• CONDUIT_CLI_INTEGRATION.md
• DTO_MIGRATION_GUIDE.md

Moved to /.claude:

• CLAUDE.md

Deleted (internal notes, not package docs):

• ISSUE_73_ANALYSIS.md
• TODOS.md (use GitHub issues instead)
• WorkLog/ directory
• phpstan-baseline.neon (was empty)

README.md completely rewritten:

• Hero section with 3-line install + 3-line usage
• Real examples: create issues, PRs, merge
• Testing section highlighting MockClient
• Clean resource table
• Removed badge clutter from top

Result

Root now has 13 items instead of 20+. Clean. Professional. Makes you want to install it.

Summary by CodeRabbit

Documentation

• Redesigned README.md with streamlined Quick Start, Real Examples section, and example-driven patterns covering facades, dependency injection, testing, and OAuth flows.
• Consolidated documentation for a cleaner, more focused guide.

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

[coderabbitai]

Walkthrough

This pull request removes multiple documentation files (architecture guide, comment filtering docs, CLI integration guide, DTO migration guide, issue analysis, todos, and work logs) and significantly rewrites the README to emphasize quick-start examples and modern usage patterns instead of feature lists.

Changes

Cohort / File(s)	Summary
Documentation Removal ARCHITECTURE.md, COMMENT_FILTERING.md, CONDUIT_CLI_INTEGRATION.md, DTO_MIGRATION_GUIDE.md, ISSUE_73_ANALYSIS.md, TODOS.md, WorkLog/12-10-2024.md	Deleted project documentation files covering architecture, comment filtering, CLI integration, DTO migration patterns, issue analysis, task tracking, and work log entries.
README Restructure README.md	Replaced feature-focused documentation layout with example-driven presentation. Removed badge suite and feature bullet list; introduced Quick Start flow, Real Examples section, and usage narratives around facades vs. dependency injection, type-safe responses, testing with MockClient, and OAuth flows.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

• README.md rewrite: Verify that new examples accurately reflect current API and usage patterns; check for completeness compared to removed sections.
• Documentation removals: Confirm that removed docs don't contain critical user-facing information that should be preserved or migrated elsewhere.

Poem

📚 A rabbit hops through docs so neat,
Tidying the stack, incomplete.
Old guides gone, README's bright,
Quick examples shine so right! ✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately summarizes the main changes: cleaning up the root directory structure and modernizing the README with a focus on reducing root-level items and improving documentation presentation.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch cleanup/root-directory-organization

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

README.md (1)

155-184: Testing section is excellent, but refactor the repeated sentence openings at line 183.

The MockClient example is clear and practical. However, line 183 has three consecutive sentences beginning with "No," which affects readability.

Consider one of these refactors:

- No HTTP calls. No flaky tests. No rate limits in CI.
+ No HTTP calls, no flaky tests, no rate limits in CI.

Or:

- No HTTP calls. No flaky tests. No rate limits in CI.
+ Skip HTTP calls, avoid flaky tests, and sidestep rate limits in CI.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 99fa6da and dff91e3.

📒 Files selected for processing (8)

• ARCHITECTURE.md (0 hunks)
• COMMENT_FILTERING.md (0 hunks)
• CONDUIT_CLI_INTEGRATION.md (0 hunks)
• DTO_MIGRATION_GUIDE.md (0 hunks)
• ISSUE_73_ANALYSIS.md (0 hunks)
• README.md (1 hunks)
• TODOS.md (0 hunks)
• WorkLog/12-10-2024.md (0 hunks)

💤 Files with no reviewable changes (7)

• CONDUIT_CLI_INTEGRATION.md
• COMMENT_FILTERING.md
• DTO_MIGRATION_GUIDE.md
• ARCHITECTURE.md
• TODOS.md
• WorkLog/12-10-2024.md
• ISSUE_73_ANALYSIS.md

🧰 Additional context used

🧠 Learnings (1)

📚 Learning: 2025-12-10T05:02:33.323Z

Learnt from: CR
Repo: jordanpartridge/github-client PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-12-10T05:02:33.323Z
Learning: Implement Facade pattern via `Github` facade for convenient access to resources and support dependency injection through Laravel's service container

Applied to files:

• README.md

🪛 LanguageTool

README.md

[style] ~183-~183: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...}); ``` No HTTP calls. No flaky tests. No rate limits in CI. --- ## Available R...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)

🔇 Additional comments (7)

README.md (7)

1-32: Excellent hero section and opening—clear value proposition delivered immediately.

The new structure removes friction with a 3-line install and 3-line usage example right up front. The "Why This Package?" bullets are concise and speak to real pain points (type-safe responses, auto-pagination, testing). This is a significant improvement over feature lists and represents modern README best practices.

---

34-70: Well-structured Quick Start with clear progression.

The install → configure → use flow is intuitive. Examples show both single and paginated results with helpful comments about output. This guides users efficiently from zero to productive.

---

73-151: Real Examples section is practical and covers the key workflows.

Creating issues, PRs, comments, and type-safe filtering with enums are solid real-world use cases. The examples are readable and show actual named parameters (modern PHP style). This section effectively demonstrates the library's strengths without overwhelming new users.

---

187-198: Clean resource table provides quick reference.

The methods are well-organized and easy to scan. Good addition for discoverability.

---

201-239: Strong coverage of both Facade and DI patterns, plus OAuth flow.

The README demonstrates both Github:: facade usage and constructor-injected GithubConnectorInterface, aligning well with the library's design philosophy. OAuth example is practical for app developers. Based on learnings, this dual-pattern support is a core design goal and it's well-communicated here.

---

243-265: Concise footer with requirements and contributing guidelines.

Minimal but effective. PHP 8.2+ and Laravel 11/12 requirements are clear.

---

16-18: All badge links and workflow references are valid. The Tests badge correctly references the existing run-tests.yml workflow, and the Packagist package is active with v3.0.0 as the latest release.