docs: enhance README with comprehensive project documentation#12
Open
devin-ai-integration[bot] wants to merge 2 commits intomainfrom
Open
docs: enhance README with comprehensive project documentation#12devin-ai-integration[bot] wants to merge 2 commits intomainfrom
devin-ai-integration[bot] wants to merge 2 commits intomainfrom
Conversation
- Add centered logo, badges (npm, license, Python, Node versions) - Update tagline to reflect Issue and local codebase support - Update architecture diagram with Deno/Pyodide sandbox and tool names - Add Expert Code Review section (--expert flag, checklists, severity levels) - Add Output Formats section (markdown, json, --quiet) - Add Local Codebase Review section (--path flag) - Add full Configuration table with all env vars and defaults - Add Architecture section with directory tree and how-it-works explanation - Add Tech Stack table (DSPy, Gemini, Deno, Pyodide, FastAPI, React, Vite) - Add Development quick-reference commands - Add Supported Platforms section (macOS ARM64/x64, Linux x64) - Link to INSTALLATION.md and CONTRIBUTING.md Co-Authored-By: Sheing Ng <sng@asyncfunc.ai>
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
Co-Authored-By: Sheing Ng <sng@asyncfunc.ai>
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.
What
Complete rewrite of the README to accurately reflect the current state of the project.
Why
The existing README was outdated -- it didn't cover several features added since the initial release (expert reviews, local codebase support, output formats, the full configuration surface, etc.) and was missing architectural context that helps new users and contributors understand the project.
How
Key additions and changes:
--expertflag, built-in checklists (SOLID, security, code quality, removal), and severity levels (P0-P3)--output markdown/json,--quietflag--pathflag.env.examplewith types, defaults, and descriptionsTesting
Checklist
Link to Devin session: https://app.devin.ai/sessions/6607794c5d2b4080b7c649098ae618d9
Requested by: @sng-asyncfunc