New readme structure #209
Open
New readme structure #209
+370
−535
Conversation
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
There was a problem hiding this comment.
Pull Request Overview
This PR restructures the README organization by creating separate README files for each file type (instructions, prompts, and chat modes) instead of maintaining a single comprehensive README. The change improves navigation and provides flexibility for adding content without creating large scrolls.
- Splits the monolithic README structure into type-specific README files
- Updates the README generation script to create separate files instead of a single README
- Changes emoji from 🧩 to 💭 for chat modes section
Reviewed Changes
Copilot reviewed 5 out of 6 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| update-readme.js | Major refactor from single README generation to separate category-specific README files |
| README.prompts.md | New dedicated README for reusable prompts with comprehensive table of all prompts |
| README.instructions.md | New dedicated README for custom instructions with comprehensive table of all instructions |
Comments suppressed due to low confidence (1)
update-readme.js:38
- The emoji change from 🧩 to 💭 for the chat modes section should be documented in the PR description as part of the changes. This appears to be intentional but worth noting.
chatmodesSection: `## 💭 Custom Chat Modes
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.
Creating a new README structure that uses sub-readme's for each of the file types, rather than a single README.
This should improve navigation, and also give some flexibility on adding additional content/information without resulting in really large scrolls