docs: split README into package guides with omit markers - #6
Merged
Conversation
Publish docs/ with the README so the docs portal can load English pages from the package after omit regions are stripped.
The empty Overview heading would become a blank portal landing section, and the CLI API link was a portal-only /docs/api path.
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
1 participant
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
docs/guides that match the docs portal page list.<!-- rdlabo-docs-omit -->so the portal can load English from the published package.docs/in the npmfileslist.Test plan
docs/initialize.md,docs/usage.md,docs/options.md, anddocs/faq.mdmatch the portal guides.englishFromPackageon the collect-icons project in rdlabo-docs.Made with Cursor