Revise README order and remove markdown box - #135
Conversation
Updated README to revise the order and remove a markdown box that did not appear to belong there (and broke a link).
📝 WalkthroughWalkthroughThe README now presents Meshtastic Design Standards as a standalone section. The GitHub Copilot section retains its configuration guidance and instructs repositories to include the standards guidance. ChangesREADME documentation
Estimated code review effort: 1 (Trivial) | ~5 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
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. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@README.md`:
- Around line 99-100: Fix the incomplete instruction in the README section
preceding “## Stats”: either restore the missing fenced
`.github/copilot-instructions.md` configuration content after the “following
section” sentence, or rewrite that sentence to specify the exact text readers
must add. Ensure the resulting documentation is actionable and no longer
references absent content.
🪄 Autofix
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
| Add the following section to your repository's `.github/copilot-instructions.md` file (create the file if it doesn't exist): | ||
|
|
There was a problem hiding this comment.
🎯 Functional Correctness | 🟠 Major | ⚡ Quick win
Restore the missing Copilot configuration section.
Line 99 refers to “the following section,” but no section follows before ## Stats on Line 101. Readers cannot copy the required .github/copilot-instructions.md content. Either restore a fenced configuration snippet or change the sentence to identify the exact text to add.
Proposed wording fix
-Add the following section to your repository's `.github/copilot-instructions.md` file (create the file if it doesn't exist):
+Copy the `Design Standards` guidance above into your repository's `.github/copilot-instructions.md` file (create the file if it doesn't exist):📝 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.
| Add the following section to your repository's `.github/copilot-instructions.md` file (create the file if it doesn't exist): | |
| Copy the `Design Standards` guidance above into your repository's `.github/copilot-instructions.md` file (create the file if it doesn't exist): | |
🧰 Tools
🪛 LanguageTool
[uncategorized] ~99-~99: The official name of this software platform is spelled with a capital “H”.
Context: ... following section to your repository's .github/copilot-instructions.md file (create t...
(GITHUB)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@README.md` around lines 99 - 100, Fix the incomplete instruction in the
README section preceding “## Stats”: either restore the missing fenced
`.github/copilot-instructions.md` configuration content after the “following
section” sentence, or rewrite that sentence to specify the exact text readers
must add. Ensure the resulting documentation is actionable and no longer
references absent content.
Updated README to revise the order and remove a markdown box that did not appear to belong there (and broke a link).
Summary by CodeRabbit