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

docs.cosmos.network documentation tracking #11898

Closed
4 tasks
julienrbrt opened this issue May 8, 2022 · 3 comments
Closed
4 tasks

docs.cosmos.network documentation tracking #11898

julienrbrt opened this issue May 8, 2022 · 3 comments
Labels
T:Docs Changes and features related to documentation. T:Epic Epics

Comments

@julienrbrt
Copy link
Member

julienrbrt commented May 8, 2022

Summary

This issue tracks the pages of the cosmos-sdk documentation for completeness and up-to-dateness checks.
Modules are excluded from this tracking issue as their documentations and specs are updated during code change audits (e.g: #11362).

All the docs.cosmos.network documentation must be reviewed as part of the auditing process. (e.g: #11096)

Table of Contents

- Introduction

- Basics

- Core Concepts

- Building Modules

- IBC (external link)

- Running a Node, API and CLI

- Migrations

- List of Modules

  • As per summary, the module documentation is updated during code change audit

Tasks

  • Verify that upgrade guides (Migrations) are up-to-date
  • Verify all code snippets point to the latest version
  • Verify implementation details still match the latest version
  • Check for and solve dead links
@julienrbrt julienrbrt added T:Docs Changes and features related to documentation. T:Epic Epics labels May 8, 2022
@julienrbrt julienrbrt mentioned this issue May 8, 2022
56 tasks
@crodriguezvega
Copy link

For IBC I would recommend that you remove all content from the SDK docs and you just have a link to redirect the user to ibc-go's own documentation website.

@julienrbrt
Copy link
Member Author

We should check more often https://github.com/cosmos/cosmos-sdk/actions/workflows/linkchecker.yml. Possibly add a slack notification after we fixed all broken links when new links get broken.

Additionally, since the flattening of the module specs, the ToC in the docs are broken (as we split the file). We should have the same vuepress config than osmosis (pre-docusaurus)

@julienrbrt
Copy link
Member Author

I am reviewing all the docs as per #13471. Closing this.

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. T:Epic Epics
Projects
No open projects
Development

No branches or pull requests

2 participants