docs(readme): rewrite for standard-readme compliance#3
Merged
Conversation
- Move banner before badges (spec order: title → banner → badges) - Add Table of Contents (required for docs > 100 lines) - Rename sections: Why devcode? → Background, Command Reference → API, File Injection (cp) → File Injection - Split Quick Start into Install (with Prerequisites) and Usage sections - Fold Typical Workflow, Project Switching, Advanced Options, Internal Flow into Usage as subsections - Remove redundant Core Concepts section - Add Contributing section (required by spec) - Add license owner: MIT © Nasser Alansari (dacrystal)
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #3 +/- ##
=======================================
Coverage 93.86% 93.86%
=======================================
Files 1 1
Lines 554 554
=======================================
Hits 520 520
Misses 34 34 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
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
2 participants
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
Why devcode?→Background,Command Reference→API,File Injection (cp)→File InjectionQuick StartintoInstall(with Prerequisites) +Usage(with subsections folded in)Contributingsection; add license owner attributionSpec
Follows standard-readme section order and requirements exactly.
Test Plan
## Licenseis the final sectionpytest)