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

[Documentation]: Fix broken links pointing to restructured CometBFT v1 documentation #19904

Closed
andynog opened this issue Mar 29, 2024 · 0 comments · Fixed by #20079
Closed

[Documentation]: Fix broken links pointing to restructured CometBFT v1 documentation #19904

andynog opened this issue Mar 29, 2024 · 0 comments · Fixed by #20079
Labels
T:Docs Changes and features related to documentation.

Comments

@andynog
Copy link
Contributor

andynog commented Mar 29, 2024

Summary

As part of the CometBFT v1 future release, the documentation for CometBFT was re-structured to implement the diataxis framework structure.

External links pointing to a future v1 documentation site will be broken if not adapted. CometBFT documentation doesn't support re-directs.

Since CometBFT links are versioned (e.g. https://docs.cometbft.com/v0.38/introduction/), any new SDK release should update the links anyway (at least update the version in the URL).

In this particular case, the links also have moved, so there will be an extra effort to locate where the documents moved to. They are new under one of the four "topics" of the diataxis framework:

  • explanation
  • guides
  • references
  • tutorials

You can see the new structure here.

The CometBFT team (@andynog) will assist the SDK team with the effort of locating the new docs to fix the broken links.

NOTE: The existing documentation for CometBFT releases before v1 (v0.38.x and under) were not altered, and since the SDK also uses versioned docs I believe these docs for the SDK releases before v1 should not have been impacted.

@andynog andynog added the T:Docs Changes and features related to documentation. label Mar 29, 2024
andynog added a commit to andynog/cosmos-sdk that referenced this issue Apr 17, 2024
@coderabbitai coderabbitai bot mentioned this issue May 3, 2024
12 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
T:Docs Changes and features related to documentation.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant