[Type-System] Generate Markdown API Reference for the Type System #19986
Conversation
This file contains 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
…ugin, and remove old README.md
Convly
added
pr: doc
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
Size Change: 0 B Total Size: 2.39 MB ℹ️ View Unchanged
|
jhoward1994
reviewed
Apr 3, 2024
innerdvations
approved these changes
Apr 5, 2024
jhoward1994
approved these changes
Apr 9, 2024
echoes-hq
bot
added
the
echoes/type: documentation
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.
What does it do?
Modify the typedoc config to generate markdown documentation (github wiki theme)
Why is it needed?
The API reference needs to be generated as markdown so that we can embed it in other documentations
How to test it?
cd packages/core/typesyarn doc:tsThe doc should be generated in the
./docsfolder as readme files instead of .html