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: small update for routes change #17881

Merged
merged 2 commits into from
Sep 26, 2023
Merged

docs: small update for routes change #17881

merged 2 commits into from
Sep 26, 2023

Conversation

samricotta
Copy link
Contributor

Description

This will fix the routing issue in the docs-repo

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
  • run make lint and make test
  • 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)

@samricotta samricotta requested a review from a team as a code owner September 26, 2023 11:15
@julienrbrt julienrbrt changed the title refactor: small update for routes change and file name change docs: small update for routes change and file name change Sep 26, 2023
@samricotta samricotta mentioned this pull request Sep 26, 2023
Merged
@github-prbot github-prbot requested a review from a team September 26, 2023 11:24
julienrbrt
julienrbrt reviewed Sep 26, 2023
View reviewed changes
x/README.md
@@ -1,6 +1,5 @@
---
sidebar_position: 0
slug : /modules
Copy link
Member

Choose a reason for hiding this comment

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

What's the reason of this removal?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is the reason that the /main/build/modules routes are broken, the slug isnt allowing the docs to pick up the readme. I removed this on all of the other versions in the sdk-docs repo and it fixed the issue

tac0turtle
tac0turtle reviewed Sep 26, 2023
View reviewed changes
docs/learn/intro/00-what-is-sdk.md Outdated
Copy link
Member

Choose a reason for hiding this comment

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

why this rename?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is so it aligns with the rest of the docs, this is the only naming that still remains as overview so its enabling broken links

Copy link
Member

Choose a reason for hiding this comment

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

https://github.com/cosmos/cosmos-sdk/blob/release/v0.50.x/docs/docs/learn/intro/00-overview.md

v50 has overview as well. seems like it is aligned?

Copy link
Member

Choose a reason for hiding this comment

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

+1 to not change the name

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think these have been copied across from the cosmos-sdk repo. In the mockups a while back the naming was to change due to UX reasons to https://cosmos.github.io/cosmos-sdk-docs/main/develop/intro/what-is-sdk as it had overview as a title then What is the sdk, which I felt was confusing and what is the sdk fit more with users questions. If you both think its not needed, we can drop it

Copy link
Member

Choose a reason for hiding this comment

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

Tbh I never linked that name as an url path 😅
As a title that makes sense.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

ha which one you mean

Copy link
Member

@julienrbrt julienrbrt Sep 26, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

00-overview.md -> 00-what-is-sdk.md, found what-is-sdk too verbose :D

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Okay fair, ill kill this change now

@julienrbrt julienrbrt changed the title docs: small update for routes change and file name change docs: small update for routes change Sep 26, 2023
@julienrbrt julienrbrt added this pull request to the merge queue Sep 26, 2023
@julienrbrt julienrbrt added backport/v0.47.x PR scheduled for inclusion in the v0.47's next stable release backport/v0.50.x PR scheduled for inclusion in the v0.50's next stable release labels Sep 26, 2023
Merged via the queue into main with commit 7f2fc56 Sep 26, 2023
43 checks passed
@julienrbrt julienrbrt deleted the sam/updates-docs-repo branch September 26, 2023 15:39
mergify bot pushed a commit that referenced this pull request Sep 26, 2023
@samricotta @mergify
docs: small update for routes change (#17881)
cb78704 
(cherry picked from commit 7f2fc56)
@mergify mergify bot mentioned this pull request Sep 26, 2023
Merged
mergify bot pushed a commit that referenced this pull request Sep 26, 2023
@samricotta @mergify
docs: small update for routes change (#17881)
6ab2e37 
(cherry picked from commit 7f2fc56)
@mergify mergify bot mentioned this pull request Sep 26, 2023
Merged
julienrbrt pushed a commit that referenced this pull request Sep 26, 2023
@mergify @samricotta
docs: small update for routes change (backport #17881) (#17886)
6403f7c 
Co-authored-by: samricotta <[email protected]>
julienrbrt pushed a commit that referenced this pull request Sep 26, 2023
@mergify @samricotta
docs: small update for routes change (backport #17881) (#17887)
8d6c611 
Co-authored-by: samricotta <[email protected]>
mmsqe pushed a commit to mmsqe/cosmos-sdk that referenced this pull request Oct 9, 2023
@mergify @samricotta @mmsqe
docs: small update for routes change (backport cosmos#17881) (cosmos#…
d088a00 
…17887)

Co-authored-by: samricotta <[email protected]>
@faddat faddat mentioned this pull request Mar 20, 2024
Open
12 tasks
@0xstepit 0xstepit mentioned this pull request Jul 1, 2024
Merged
@faddat faddat mentioned this pull request Nov 8, 2024
Closed
12 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tac0turtle tac0turtle tac0turtle left review comments

@julienrbrt julienrbrt julienrbrt approved these changes

Assignees
No one assigned
Labels
backport/v0.47.x PR scheduled for inclusion in the v0.47's next stable release backport/v0.50.x PR scheduled for inclusion in the v0.50's next stable release
Projects
None yet
Milestone
No milestone
Development

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