feat: docs generator #1290
Merged
feat: docs generator #1290
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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
1 Ignored Deployment
|
marcelovicentegc
added
the
documentation
Closed
marcelovicentegc
force-pushed
the
feat/auto-generate-docs
branch
from
8d28962
to
4605b9b
Compare
marcelovicentegc
force-pushed
the
feat/auto-generate-docs
branch
from
4605b9b
to
d114045
Compare
matheusps
reviewed
Nov 30, 2023
marcelovicentegc
force-pushed
the
feat/auto-generate-docs
branch
from
617ca56
to
4b310ee
Compare
matheusps
approved these changes
Dec 13, 2023
1 task
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.
Summary
This is the first iteration related to #1030.
Resolves #1030 by leveraging typedoc and handlebars to generate docs from our code. It parses typedoc output to fit our needs, organising it into our next-docs folder structure and file split.
Adds a new package,
@vtex/docs-generator, to shoreline. Its README contains information, development instructions and best practices to generate meaningful documentation from our libraries. Please check it out.The script is not yet implemented on git hooks nor CI. Ideally, we will iterate a couple more times generating docs before including it on one of these automated processes.
From this PR onwards, we must
Examples
Take a look at the changes of this PR. It updates all existing docs to the generated ones as described in #1356 🥳
Also resolves #1367 (it was quite fast to implement the evolution)