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 IBC links #9005

Merged
merged 3 commits into from
Mar 27, 2021
Merged

fix IBC links #9005

merged 3 commits into from
Mar 27, 2021

Conversation

colin-axner
Copy link
Contributor

Description

copied over from ibc-go pr

closes: #8966


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

@colin-axner colin-axner added the T:Docs Changes and features related to documentation. label Mar 26, 2021
@amaury1093
Copy link
Contributor

@colin-axner right now IBC docs are shown inside a section on the left on docs.cosmos.network. Do we want to keep that, or does IBC have a plan to have its own docs page? Maybe we could just delete the docs/ibc folder from the SDK to avoid these copy/paste PRs?

@colin-axner
Copy link
Contributor Author

@colin-axner right now IBC docs are shown inside a section on the left on docs.cosmos.network. Do we want to keep that, or does IBC have a plan to have its own docs page? Maybe we could just delete the docs/ibc folder from the SDK to avoid these copy/paste PRs?

The plan is to eventually create a docs subdomain for ibc-go, but in the short term we should maintain the docs in the SDK. A lot of folks are looking into this documentation since transfer enablement on a lot of chains is imminent. Once there is a docs site up for ibc-go we can remove the docs from the SDK

@colin-axner colin-axner added the A:automerge Automatically merge PR once all prerequisites pass. label Mar 26, 2021
barriebyron pushed a commit to barriebyron/cosmos-sdk that referenced this pull request Mar 26, 2021
@orijbot
Copy link

orijbot commented Mar 26, 2021

@orijbot
Copy link

orijbot commented Mar 26, 2021

Copy link
Contributor

@barriebyron barriebyron left a comment

Choose a reason for hiding this comment

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

no hyphen in prerequisites

docs/ibc/relayer.md Outdated Show resolved Hide resolved
@barriebyron barriebyron self-requested a review March 26, 2021 18:41
@mergify mergify bot merged commit a5bd6b3 into master Mar 27, 2021
@mergify mergify bot deleted the colin/fix-ibc-doc-links branch March 27, 2021 01:10
tac0turtle pushed a commit that referenced this pull request Mar 30, 2021
* went to fix a broken link and then got caught up in an editorial quick sweep to address style, typos, and clarity issues

* typo

* removed the commented out link to use cases, can replace with link to website when the site has the use cases.

* get corrected links from #9005

* Update docs/ibc/overview.md

Co-authored-by: colin axnér <25233464+colin-axner@users.noreply.github.com>

* Apply Colin's suggestions from code review

thank you for your careful review, I appreciate you

Co-authored-by: colin axnér <25233464+colin-axner@users.noreply.github.com>

* resolve merge conflict with link fixes, I hope these are correct

* is like (was analogous)

Co-authored-by: colin axnér <25233464+colin-axner@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A:automerge Automatically merge PR once all prerequisites pass. T:Docs Changes and features related to documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Fix IBC doc links
5 participants