Skip to content
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

Merged
merged 4 commits into from
Sep 28, 2022
Merged

Fix docs rendering issue #2421

merged 4 commits into from
Sep 28, 2022

Conversation

chatton
Copy link
Contributor

@chatton chatton commented Sep 28, 2022

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.

  • Targeted PR against correct branch (see CONTRIBUTING.md)
  • Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
  • Code follows the module structure standards.
  • Wrote unit and integration tests
  • Updated relevant documentation (docs/) or specification (x/<module>/spec/)
  • Added relevant godoc comments.
  • Added a relevant changelog entry to the Unreleased section in CHANGELOG.md
  • Re-reviewed Files changed in the Github PR explorer
  • Review Codecov Report in the comment section below once CI passes

@chatton chatton changed the title Fix docs rendering Fix docs rendering issue Sep 28, 2022
"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"
Copy link
Contributor Author

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.

Copy link
Contributor

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

Copy link
Member

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

Copy link
Member

@damiannolan damiannolan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Legendary 🥇

Copy link
Contributor

@crodriguezvega crodriguezvega left a 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!

@chatton chatton merged commit 0168efb into main Sep 28, 2022
@chatton chatton deleted the cian/fix-docs-rendering branch September 28, 2022 12:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Fix docs rendering issue
4 participants