[Focused Improvements] Generate API reference docs #840
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
|
This pull request is being automatically deployed with Vercel (learn more). 🔍 Inspect: https://vercel.com/sitecore-jss/edge-e2e-styleguide/E999AFr4E1mBxhFZg4Z4EgfAdiEE [Deployment for db2e3f3 failed] |
CobyPear
suggested changes
Oct 27, 2021
CobyPear
approved these changes
Oct 29, 2021
CobyPear
reviewed
Oct 29, 2021
package.json
Outdated
| @@ -37,4 +37,4 @@ | |||
| "typescript": "^3.9.6" | |||
| }, | |||
| "dependencies": {} | |||
There was a problem hiding this comment.
Sorry, missed this - can we remove this empty dependencies object?
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.
Utilized TypeDoc to generate API reference docs for all the base packages.
With 1 Lerna script at the root package.json, we are able to generate docs for all the packages.
Description / Motivation
This would benefit our team internally, but also may be used for public docs if we want.
Testing Details
Run
npm run generate-docsfrom the root of the repo.Types of changes
/docsdirectory)