-
Notifications
You must be signed in to change notification settings - Fork 627
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Fix docs rendering issue #2421
Fix docs rendering issue #2421
Conversation
"node-forge": "^1.3.1", | ||
"nth-check": "^2.1.1", | ||
"url-parse": "^1.5.10", | ||
"vue": "^2.6.14", | ||
"vuepress-theme-cosmos": "^1.0.183" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@colin-axner do you have some more context about these packages? I don't think we need any of these as direct dependencies.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Unfortunately no, these additions were the result of trying to bump the versions for these packages as they were causing "security vulnerability" notifications (nothing that affects our code, just docs - and even then I'm not sure there is anything exploitable)
I believe we get these dependencies indirectly from vuepress-cosmos-theme
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
insert node modules heaviest matter in the universe meme
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Legendary 🥇
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great work, @chatton and @damiannolan!
Description
The docs were not rendering correctly, it looks like they stopped rendering after this commit however they still successfully built.
To test, checkout this branch
rm -rf docs/node_modules make view-docs # navigate to localhost:8080
closes: #2420
Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.
docs/
) or specification (x/<module>/spec/
)godoc
comments.Unreleased
section inCHANGELOG.md
Files changed
in the Github PR explorerCodecov Report
in the comment section below once CI passes