New docs with monorepo support #1588
Merged
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
to place typedoc on the root level
…and LICENSE was broken. fixed this
existing docs commands still exist as `docs-legacy` in order to preserve the exising URLs I will try to redirect them in the next commit Set `name` for each packages' `typedoc.json` to make their URL not being like `_pixiv_three-vrm` `/guides/README.md` is removed since it appears as "README" on the docs menu and it doesn't make sense Also updated the inspect.yml to build and publish both old and new docs I have 20% confidence this ci will work on the first try
used typedoc plugin. Referred the existing redirect plugin See: https://github.com/Gerrit0/typedoc-plugin-redirect/blob/main/src/plugin.ts
also `yarn clean` now cleans the root `docs/`
yue4u
reviewed
Mar 6, 2025
| const matchItems = path.match(/packages\/(.+)\/docs\/(classes|interfaces|functions|types|variables)\/(.+)/); | ||
| if (matchItems != null) { | ||
| const [_, packageName, kind, item] = matchItems; | ||
| return `../../../docs/${kind}/${packageName}.${item}`; |
There was a problem hiding this comment.
The relative path ../../../ does not work for nested docs like /packages/three-vrm/docs/variables/VRMExpressionMaterialColorType-1.html. Maybe using /docs/ is better?
There was a problem hiding this comment.
Oops that's true. will change it to simply use /docs/....
There was a problem hiding this comment.
no that wouldn't work because the document root will be https://pixiv.github.io/three-vrm/docs/ on GitHub Pages. I would try setting the document root using environment variable.
There was a problem hiding this comment.
make it use an environment variable DOCS_ROOT.
the previous redirect using the relative path does not work when the page is nested Use `DOCS_ROOT` environment variable to specify the correct absolute path #1588 (comment)
0b5vr
added a commit
that referenced
this pull request
Mar 10, 2025
We have updated the docs structure in the previous PR: #1588
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.
This PR introduces the new docs page with the monorepo support.
Existing docs for each package still exist and can be generated by running the
docs-legacycommand. These docs redirect to the new URL.It consumes a long time to generate. We might want to remove it in the future.
Also, existing
/docs/in the root level is moved to/guides/.See details for the each commit.