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

[Epic]: Documentation revamp #15705

Closed
3 tasks done
samricotta opened this issue Apr 5, 2023 · 1 comment
Closed
3 tasks done

[Epic]: Documentation revamp #15705

samricotta opened this issue Apr 5, 2023 · 1 comment
Assignees
Labels
T:Docs Changes and features related to documentation. T:Epic Epics

Comments

@samricotta
Copy link
Contributor

samricotta commented Apr 5, 2023

Summary

Campaign to revamp the documentation

Problem Definition

There are 2 things that need to be focused on

  • There is a need for comprehensive user documentation, which is currently absent. Creating this documentation will facilitate easy access to information and enhance the user experience by making it simpler for users to find what they need.
  • Amend the current developer documentation to improve usability, flow and intuitiveness

Work Breakdown

  • Landing page: providing an entry point for each user type
  • Add user journeys for chain developers and users on the landing page

Develop:

  • Concepts: providing users with a high level overview of Cosmos SDK concepts
  • Glossary
  • Create new docs repo for landing and user docs

Integrate:

  • Re-structure the categories for more intuitive navigation
  • Overhaul of tutorials section: within this identify which tutorials would make sense and be the most valuable

User Section:

  • Flesh out the user section and add additional pieces such as multisig transactions

Validate Section:

  • Add section on how to run a validator and sentry

General

Issues to be looked at and pages to be re-visted:

Versioning
Overview: With the versioning, the idea was to create a script so it builds in the CI and a script must be created to ensure if anything is updated in the cosmos-sdk repo it will automatically change in the docs repo

UPDATE:
The following needs to be updated for the versioning
There are link updates for 0.45 and 0.46 to move completely across to docusaurus due to the
https://github.com/cosmos/cosmos-sdk-docs/actions/runs/5814414059/job/15764054018?pr=12

Smaller tasks

  1. T:Docs
@tac0turtle
Copy link
Member

https://docs.cosmos.network/v0.50/learn/intro/overview

new docs site, who 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
None yet
Development

No branches or pull requests

3 participants