Repository navigation
docs: compress README opening, add CONTRIBUTING and AGPL notes - #11
Merged
Merged
Conversation
- Shorten the README opening to the problem, a Mermaid diagram, and the install command (EN and zh-CN). - Make npm install -g devcodex the single recommended install method. - Explain what AGPL-3.0-or-later means for users and update the license badge. - Add CONTRIBUTING.md and link it from the shortened Contributing section. - Regenerate content/skills/portfolio.json because CONTRIBUTING.md is a tracked consumer.
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
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
Pre-promotion documentation cleanup. Docs only, plus one regenerated generated file.
npm link), validation commands, PR guidelines, and the license of contributions. It links RULES.md and notes that it is in Chinese. It is not added to the npmfileslist.npm install -g devcodexis the only recommended install method. Doc links and section links are on one line. The "keep your existing task" note moves to 5-minute start → Install. All existing section anchors still resolve.AGPL-3.0-or-laterto matchpackage.json. The License section now explains what the AGPL means for users (use, private changes, distribution, network use under §13). It is a plain-language summary, not legal advice.node scripts/generate-skill-portfolio.js, not edited by hand. CONTRIBUTING.md is a tracked consumer file, so the consumer inventory went from 736 to 737.Verification (local)
node scripts/test-readme-governance.js: passnode scripts/generate-skill-portfolio.js --check: pass