You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
tbd the actionables of each piece that needs to be amended in the developer documentation
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
Summary
Campaign to revamp the documentation
Problem Definition
There are 2 things that need to be focused on
Work Breakdown
Develop:
Integrate:
User Section:
Validate Section:
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
cosmos-sdk
repo #17642The text was updated successfully, but these errors were encountered: