Add Why, Architecture, and Configuration sections to README#20
Merged
AnExiledDev merged 1 commit intomainfrom Feb 26, 2026
Merged
Add Why, Architecture, and Configuration sections to README#20AnExiledDev merged 1 commit intomainfrom
AnExiledDev merged 1 commit intomainfrom
Conversation
|
Caution Review failedThe pull request is closed. ℹ️ Recent review infoConfiguration used: defaults Review profile: CHILL Plan: Pro 📒 Files selected for processing (2)
📝 WalkthroughWalkthroughAdded documentation content: updates to Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@README.md`:
- Around line 100-103: Update the DevContainer feature count to match the
documented list by changing the phrase "22 custom features" in the
"DevContainer" paragraph to "21 custom features"; verify the "Custom Features
(21)" section header and any other occurrences of the custom features count
(search for "22 custom features" and "Custom Features (21)") so all counts are
consistent across the README.
- Around line 87-98: The fenced ASCII-art block in README.md lacks a language
hint causing MD040; update the triple-backtick fence for the block that contains
the Claude Code/CodeForge/DevContainer diagram to include a language identifier
(for example "text") so the fence becomes ```text, preserving the existing ASCII
content inside; locate the README.md fenced block that starts with the box
drawing and add the language hint to the opening fence.
Comment on lines
+87
to
+98
| ``` | ||
| ┌──────────────────────────────────────────────┐ | ||
| │ Claude Code │ | ||
| │ AI assistant, tool execution, Agent Teams │ | ||
| ├──────────────────────────────────────────────┤ | ||
| │ CodeForge Layer │ | ||
| │ Plugins · Agents · Skills · Hooks · Rules │ | ||
| ├──────────────────────────────────────────────┤ | ||
| │ DevContainer │ | ||
| │ Runtimes · CLI Tools · LSP Servers │ | ||
| └──────────────────────────────────────────────┘ | ||
| ``` |
There was a problem hiding this comment.
Add a language hint to the architecture code fence (MD040).
Markdown lint is correct here: the fenced block should declare a language for consistency/tooling compatibility.
Suggested patch
-```
+```text
┌──────────────────────────────────────────────┐
│ Claude Code │
│ AI assistant, tool execution, Agent Teams │
@@
└──────────────────────────────────────────────┘</details>
<!-- suggestion_start -->
<details>
<summary>📝 Committable suggestion</summary>
> ‼️ **IMPORTANT**
> Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
```suggestion
🧰 Tools
🪛 markdownlint-cli2 (0.21.0)
[warning] 87-87: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@README.md` around lines 87 - 98, The fenced ASCII-art block in README.md
lacks a language hint causing MD040; update the triple-backtick fence for the
block that contains the Claude Code/CodeForge/DevContainer diagram to include a
language identifier (for example "text") so the fence becomes ```text,
preserving the existing ASCII content inside; locate the README.md fenced block
that starts with the box drawing and add the language hint to the opening fence.
Comment on lines
+100
to
+103
| **DevContainer** — The foundation. A Python 3.14 container with Node.js, Rust, and Bun runtimes, plus 22 custom features that install development tools (ast-grep, tree-sitter, biome, ruff, and others). | ||
|
|
||
| **CodeForge Layer** — The intelligence. 13 plugins register hooks that validate commands, inject context, and enforce safety. 17 agents provide specialized personas. 35 skills offer on-demand reference material. System prompts and rules shape behavior. | ||
|
|
There was a problem hiding this comment.
Feature count is inconsistent in this section.
Line 100 says “22 custom features”, but the README’s own “Custom Features (21)” section lists 21. Please align this count to avoid reader confusion.
Suggested patch
-**DevContainer** — The foundation. A Python 3.14 container with Node.js, Rust, and Bun runtimes, plus 22 custom features that install development tools (ast-grep, tree-sitter, biome, ruff, and others).
+**DevContainer** — The foundation. A Python 3.14 container with Node.js, Rust, and Bun runtimes, plus 21 custom features that install development tools (ast-grep, tree-sitter, biome, ruff, and others).📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| **DevContainer** — The foundation. A Python 3.14 container with Node.js, Rust, and Bun runtimes, plus 22 custom features that install development tools (ast-grep, tree-sitter, biome, ruff, and others). | |
| **CodeForge Layer** — The intelligence. 13 plugins register hooks that validate commands, inject context, and enforce safety. 17 agents provide specialized personas. 35 skills offer on-demand reference material. System prompts and rules shape behavior. | |
| **DevContainer** — The foundation. A Python 3.14 container with Node.js, Rust, and Bun runtimes, plus 21 custom features that install development tools (ast-grep, tree-sitter, biome, ruff, and others). | |
| **CodeForge Layer** — The intelligence. 13 plugins register hooks that validate commands, inject context, and enforce safety. 17 agents provide specialized personas. 35 skills offer on-demand reference material. System prompts and rules shape behavior. | |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@README.md` around lines 100 - 103, Update the DevContainer feature count to
match the documented list by changing the phrase "22 custom features" in the
"DevContainer" paragraph to "21 custom features"; verify the "Custom Features
(21)" section header and any other occurrences of the custom features count
(search for "22 custom features" and "Custom Features (21)") so all counts are
consistent across the README.
Adds three sections identified as gaps in the repo quality audit: - "Why CodeForge?" — motivation and origins as a power user's setup - Architecture overview with three-layer diagram - Configuration summary table with link to docs site
AnExiledDev
force-pushed
the
readme-enhancements
branch
from
a421b80 to
9b93ae3
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
All three sections were identified as gaps in the repo quality audit (REPO-AUDIT.md).
Test plan
## [Unreleased]Summary by CodeRabbit