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.

Sign up for GitHub

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

Jump to bottom

docs: improve docs #12647

Merged
merged 3 commits into from
Jul 20, 2022
Merged

docs: improve docs #12647

merged 3 commits into from
Jul 20, 2022

Conversation

julienrbrt
Copy link
Member

@julienrbrt julienrbrt commented Jul 20, 2022 •
edited
Loading

Description

Quick PR for little nits on the docs.cosmos.network.

  • Change footer (align with ibc-go docs)
  • Improve GitHub action for rebuilding the docs on docs changes from release branches
  • Fix the edit button for the docs.
  • Remove deprecated languages (there has been no translation since more than 3 versions, I think we can remove it)

I have been looking at https://github.com/cosmos/vuepress-theme-cosmos/blob/develop/layouts/GlobalLayout.vue, as it would be nice to have a banner that warns users when they are on the main branch documentation. Unfortunately, the banner is hard-coded to display https://v1.cosmos.network/top-banner/index.json...

I've used the trick to put the default version at the end of the versions file instead, and created cosmos/vuepress-theme-cosmos#359.

Note: when backporting docsBranch: "main" should be changed to the correct branch.

Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct type prefix in the PR title
  • added ! to the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • followed the guidelines for building modules
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • included comments for documenting Go code
  • updated the relevant documentation or specification
  • reviewed "Files changed" and left comments if necessary
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed ! in the type prefix if API or client breaking change
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic
  • reviewed API design and naming
  • reviewed documentation is accurate
  • reviewed tests and test coverage
  • manually tested (if applicable)

@julienrbrt julienrbrt added the backport/0.46.x PR scheduled for inclusion in the v0.46's next stable release label Jul 20, 2022
@julienrbrt julienrbrt requested a review from a team as a code owner July 20, 2022 09:25
amaury1093
amaury1093 approved these changes Jul 20, 2022
View reviewed changes
Copy link
Contributor

@amaury1093 amaury1093 left a comment

Choose a reason for hiding this comment

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

utACK, but everything makes sense!

tac0turtle
tac0turtle approved these changes Jul 20, 2022
View reviewed changes
Copy link
Member

@tac0turtle tac0turtle left a comment

Choose a reason for hiding this comment

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

utACK. yolo merge

@tac0turtle tac0turtle merged commit 987959c into main Jul 20, 2022
@tac0turtle tac0turtle deleted the julien/improve-docs branch July 20, 2022 12:04
mergify bot pushed a commit that referenced this pull request Jul 20, 2022
@julienrbrt @mergify
docs: improve docs (#12647)
4963d1e 
* docs: improve docs

* set default version

(cherry picked from commit 987959c)

# Conflicts:
#	.github/workflows/deploy-docs.yml
@mergify mergify bot mentioned this pull request Jul 20, 2022
Merged
amaury1093 pushed a commit that referenced this pull request Jul 20, 2022
@mergify @julienrbrt
docs: improve docs (backport #12647) (#12650)
b823b17 
* docs: improve docs (#12647)

* docs: improve docs

* set default version

(cherry picked from commit 987959c)

# Conflicts:
#	.github/workflows/deploy-docs.yml

* updates

Co-authored-by: Julien Robert <julien@rbrt.fr>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tac0turtle tac0turtle tac0turtle approved these changes

@amaury1093 amaury1093 amaury1093 approved these changes

Assignees
No one assigned
Labels
backport/0.46.x PR scheduled for inclusion in the v0.46's next stable release Type: CI
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@julienrbrt @amaury1093 @tac0turtle