Skip to content

docs(readme): rewrite for newcomers#131

Merged
ANcpLua merged 1 commit intomainfrom
docs/simplified-readme
Feb 15, 2026
Merged

docs(readme): rewrite for newcomers#131
ANcpLua merged 1 commit intomainfrom
docs/simplified-readme

Conversation

@ANcpLua
Copy link
Owner

@ANcpLua ANcpLua commented Feb 15, 2026

Summary

  • Rewrites README with plain-language descriptions someone without dev experience can understand
  • Adds gate system explanation ("every step is a gate, PROCEED or HALT")
  • Adds marketplace install instructions (/plugin marketplace add)
  • Keeps technical details section for developers who want specifics

Test plan

  • Verify weave-validate.sh passes
  • Confirm CHANGELOG entry under [Unreleased]
  • Read the descriptions — do they make sense to a non-developer?

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Updated README with clearer, neutral language and expanded installation guidance
    • Added new sections explaining parallel quality gates and batch processing workflows
    • Enhanced technical details with concrete architecture information
    • Standardized terminology throughout documentation
    • Updated CHANGELOG to reflect documentation improvements

Replaces technical jargon with accessible explanations of what each plugin
does. Adds gate system explanation, marketplace install instructions, and
the framing: one developer, twelve parallel workers, zero unchecked steps.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings February 15, 2026 08:59
@chatgpt-codex-connector
Copy link

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.

@gemini-code-assist
Copy link

Summary of Changes

Hello @ANcpLua, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly enhances the user experience for newcomers by revamping the README.md file. The primary goal is to demystify the project's plugin marketplace and its functionalities, making it understandable for individuals without a technical background. This change aims to lower the barrier to entry and improve overall project accessibility.

Highlights

  • README.md Rewrite: The README.md has been completely rewritten to use plain-language descriptions, making it accessible to users without prior development experience.
  • Gate System Explanation: A new section explaining the 'gate system' has been added to the README.md, clarifying how work progresses with automatic quality checks.
  • Marketplace Install Instructions: Installation instructions in the README.md have been updated to include how to add the plugin marketplace using /plugin marketplace add.
  • Technical Details Retained: The README.md retains a dedicated section for technical details, ensuring developers can still find specific information.
Changelog
  • CHANGELOG.md
    • Added a new 'Changed' entry detailing the README.md rewrite for newcomers, emphasizing plain-language descriptions, gate system explanation, and marketplace install instructions.
Activity
  • Verified weave-validate.sh passes.
  • Confirmed CHANGELOG entry under [Unreleased].
  • Read the descriptions to ensure they make sense to a non-developer.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@coderabbitai
Copy link

coderabbitai bot commented Feb 15, 2026

Caution

Review failed

Failed to post review comments

📝 Walkthrough

Walkthrough

The PR updates project documentation to improve clarity for newcomers. CHANGELOG.md documents a README rewrite effort. README.md is significantly restructured, replacing technical jargon with plain-language descriptions, reorganizing sections, and simplifying feature and installation information.

Changes

Cohort / File(s) Summary
Documentation Updates
CHANGELOG.md
Added changelog entry documenting the README rewrite for improved accessibility to newcomers.
README Rewrite
README.md
Comprehensive documentation overhaul: replaced marketing-focused language with neutral, process-oriented descriptions; restructured plugin information from versioned specs to plain-language capabilities; expanded installation instructions to marketplace-based setup; renamed "Architecture" section to "Technical details"; reorganized repository outline; added "How does this work without failing?" subsection; normalized terminology throughout.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

🚥 Pre-merge checks | ✅ 4
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: rewriting the README for newcomers with plain-language explanations, which is the primary objective of this pull request.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Merge Conflict Detection ✅ Passed ✅ No merge conflicts detected when merging into main

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

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch docs/simplified-readme

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

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

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request is a great step towards making the project more accessible to newcomers by rewriting the README.md with clearer, plain-language descriptions. The changes are well-aligned with the goal, and the update to CHANGELOG.md is correct.

My review includes one suggestion for the README.md file to align the plugin description table with the repository's style guide regarding line length. The suggested changes also aim to improve conciseness while retaining the helpful, non-technical tone.

Comment on lines +17 to +25
| Plugin | What it does in plain language |
|--------|-------------------------------|
| **exodia** | Summons up to 12 AI workers that tackle different parts of your code simultaneously. One finds problems, another fixes them, another reviews the fix — all at the same time |
| **metacognitive-guard** | Watches the AI while it works. If it's about to cut corners, guess instead of verify, or say "done" when it isn't — this blocks it before the mistake happens |
| **feature-dev** | A guided process for building new things: understand what exists, design the plan, build it, review it. No skipping steps |
| **hookify** | Custom tripwires you set up. "Never do X" or "Always check Y before Z." The AI physically cannot proceed if it violates your rules |
| **otelwiki** | Built-in reference for OpenTelemetry monitoring standards so the AI writes correct telemetry code instead of guessing |
| **dotnet-architecture-lint** | Enforces .NET project structure rules automatically — catches version mismatches and structural violations before they ship |
| **ancplua-project-routing** | Automatically recognizes what kind of project you're in and loads the right tools and rules. No configuration needed |

Choose a reason for hiding this comment

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

low

The new descriptions are much more accessible, which is a great improvement for newcomers!

However, several descriptions in the table exceed the 120-character line length specified in the repository style guide. I've suggested more concise versions below that still capture the essence of each plugin while adhering to the length limit.

Suggested change
| Plugin | What it does in plain language |
|--------|-------------------------------|
| **exodia** | Summons up to 12 AI workers that tackle different parts of your code simultaneously. One finds problems, another fixes them, another reviews the fix — all at the same time |
| **metacognitive-guard** | Watches the AI while it works. If it's about to cut corners, guess instead of verify, or say "done" when it isn't — this blocks it before the mistake happens |
| **feature-dev** | A guided process for building new things: understand what exists, design the plan, build it, review it. No skipping steps |
| **hookify** | Custom tripwires you set up. "Never do X" or "Always check Y before Z." The AI physically cannot proceed if it violates your rules |
| **otelwiki** | Built-in reference for OpenTelemetry monitoring standards so the AI writes correct telemetry code instead of guessing |
| **dotnet-architecture-lint** | Enforces .NET project structure rules automatically — catches version mismatches and structural violations before they ship |
| **ancplua-project-routing** | Automatically recognizes what kind of project you're in and loads the right tools and rules. No configuration needed |
| Plugin | What it does in plain language |
|--------|--------------------------------|
| **exodia** | Orchestrates up to 12 AI workers to find, fix, and review code in parallel. |
| **metacognitive-guard** | Acts as a quality gate for the AI, blocking corner-cutting, guessing, or false claims of completion. |
| **feature-dev** | A guided process for building new things: understand, design, build, and review. No skipping steps. |
| **hookify** | Lets you define custom rules (e.g., "Never do X") that the AI is not allowed to violate. |
| **otelwiki** | Provides a built-in OpenTelemetry reference to ensure the AI writes correct telemetry code. |
| **dotnet-architecture-lint** | Enforces .NET project structure rules, catching version mismatches and violations before they ship. |
| **ancplua-project-routing** | Auto-recognizes project type to load the right tools and rules, with no configuration needed. |
References
  1. Markdown files should have a maximum line length of 120 characters. (link)

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR rewrites the README.md to make it accessible to non-developers while maintaining technical details for developers. The rewrite replaces technical jargon with plain-language descriptions, adds an explanation of the quality gate system ("every step is a gate, work only moves forward if the gate says PROCEED"), and updates installation instructions to use the marketplace approach with /plugin commands.

Changes:

  • Replaced plugin descriptions with plain-language explanations of what each plugin does in practice
  • Added "How does this work without failing?" section explaining the gate system concept
  • Updated install instructions to use marketplace commands (/plugin marketplace add and /plugin install)
  • Reorganized content into "What this does", "Plugins", "Install", and "Technical details" sections

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
README.md Complete rewrite for accessibility: plain-language plugin descriptions, gate system explanation, marketplace install flow, technical stats moved to dedicated section
CHANGELOG.md Added entry under [Unreleased] > Changed documenting the README rewrite

@ANcpLua ANcpLua merged commit ed11dc7 into main Feb 15, 2026
22 of 23 checks passed
@ANcpLua ANcpLua deleted the docs/simplified-readme branch February 15, 2026 10:30
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.

2 participants