Verify full codebase, parse both README.md files, and fuse into single new revised README.md#86
Conversation
read README_1.md and README_2.md Both seem to be accurate about the codebase. After that verify the whole codebase to also then be doubly sure and use that to create a README_3.md Come up with a PLAN.md to fuse all three readmes into a new README.md Use multiple subagents to help you. After that execute PLAN.md. Once again, use multiple subagents to help you. Make the new README.md read like a tech guide and easy for tech noobs to follow, and should not be too long. Meaning that you can link the information into more markdown docs that can be put in the docs/ folder.
|
Hi Team - just FYI. Additionally: To see the intermediary plan that AI generated, you can check this commit here For each file that you see once you visit the page, click on Load Diff to show the content. Thanks! |
SonarQube reviewer guideSummary: Significantly streamlined README documentation, transitioning from a comprehensive 676-line guide to a concise 196-line quick-start document, while moving detailed content into dedicated markdown files (MANUAL-MIGRATION.md, DOCKER.md, TROUBLESHOOTING.md, SECURITY.md, ARCHITECTURE.md, BUILD.md, CONFIG.md). Review Focus: This is primarily a documentation restructuring rather than code changes. Key areas to review:
Start review at:
|
2 participants
AI Prompt:
read README_1.md and README_2.md
Both seem to be accurate about the codebase.
After that verify the whole codebase to also then be doubly sure and use that to create a README_3.md
Come up with a PLAN.md to fuse all three readmes into a new README.md
Use multiple subagents to help you.
After that execute PLAN.md. Once again, use multiple subagents to help you.
Make the new README.md read like a tech guide and easy for tech noobs to follow, and should not be too long. Meaning that you can link the information into more markdown docs that can be put in the docs/ folder.