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

Migrate docs to docusaurus, Store docs for all past versions in main #3510

Closed
wants to merge 83 commits into from

Conversation

srdtrk
Copy link
Member

@srdtrk srdtrk commented Apr 24, 2023

Description

This PR:

  • Migrates the docs to docusaurus.
  • Uses the docs theme from cosmos-sdk.
  • Allows navigation to ADRs from the navbar.
  • This PR also stores docs for past versions in main. - WIP
  • Update style guides. - WIP

closes: #3492

addresses: #3488

Commit Message / Changelog Entry

docs: migrate to docusaurus, store versioned docs and sidebars in main

see the guidelines for commit messages. (view raw markdown for examples)


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 and Go style guide.
  • Wrote unit and integration tests.
  • Updated relevant documentation (docs/) or specification (x/<module>/spec/).
  • Added relevant godoc comments.
  • Provide a commit message to be used for the changelog entry in the PR description for review.
  • Re-reviewed Files changed in the Github PR explorer.
  • Review Codecov Report in the comment section below once CI passes.

srdtrk added 30 commits April 19, 2023 15:56
@srdtrk srdtrk added the docs Improvements or additions to documentation label Apr 24, 2023
@srdtrk
Copy link
Member Author

srdtrk commented Apr 24, 2023

Moving to feat branch instead

@srdtrk srdtrk closed this Apr 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Migrate from Vuepress to Docusaurus for improved documentation layout and structure.
1 participant