Split README into docs/ with a short homepage navigator - #5
Merged
Merged
Conversation
Move teaching chapters into numbered docs/*.md files, keep examples.yml and the PCRE2 checker at the repo root, and leave LICENSE unchanged. Co-authored-by: Elven_xu <799835984@qq.com>
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.
Phase 5: restructure only. Teaching meaning is unchanged;
examples.ymlcases,scripts/check_examples.py, CI, and MITLICENSEtext are untouched (one comment inexamples.ymlnow points atdocs/instead of README).File map
README.mdcheck_examples.py, license, deerchao attributiondocs/00-getting-started.mddocs/01-basics.mddocs/02-groups-and-lookaround.mddocs/03-cookbook.mddocs/04-caveats.mddocs/05-advanced.mddocs/99-appendix-dotnet.mdEach
docs/*.mdhas prev/next + 目录 links so GitHub navigation still works.What stayed at the root
examples.yml(51 cases; checker path unchanged)scripts/check_examples.py.github/workflows/ci.ymlLICENSELocal run:
passed: 49 skipped: 2 failed: 0.Attribution
章节骨架与致谢仍指向鹿鸣/deerchao《正则表达式30分钟入门教程》，写在首页「参考与致谢」。