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: add v15 specific docs, changelogs and instructions #3009

Merged
merged 14 commits into from
Mar 19, 2024

Conversation

MSalopek
Copy link
Contributor

Description

Closes: #2537

Add extra documentation to clarify API breaks and proposal submission procedures.


Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct docs: prefix in the PR title
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • reviewed "Files changed" and left comments if necessary
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

  • Confirmed the correct docs: prefix in the PR title
  • Confirmed all author checklist items have been addressed
  • Confirmed that this PR only changes documentation
  • Reviewed content for consistency
  • Reviewed content for thoroughness
  • Reviewed content for spelling and grammar
  • Tested instructions (if applicable)

@MSalopek MSalopek self-assigned this Mar 18, 2024
@MSalopek MSalopek added S: KTLO Keeping the lights on: Keeping the current product operational (bugs, troubleshooting, deps updates) scope: docs Improvements or additions to documentation labels Mar 18, 2024
Copy link
Contributor

@mpoke mpoke left a comment

Choose a reason for hiding this comment

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

Great work @MSalopek. See my comments below. Nothing blocking though.

You can find the comprehensive API docs at:
* https://docs.cosmos.network/api

Module refrence manuals (with CLI instructions) can be found at:
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we mention what modules are enabled?

Copy link
Contributor

Choose a reason for hiding this comment

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

Do we still want to have the migration instructions in the docs? I would prefer to have them in UPGRADING.md and just link to the in the docs to avoid redundancy.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Let's leave this one as is.

We can discuss what happens for >= 16.x at a later time.


To upgrade from v13 check the [**upgrade guide**](/migration/cosmoshub-4-v14-upgrade.md)
To upgrade from v14 check the [**upgrade guide**](/migration/cosmoshub-4-v15-upgrade.md)
Copy link
Contributor

Choose a reason for hiding this comment

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

Copy link
Contributor Author

Choose a reason for hiding this comment

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

You have to copy the file into the docs folder. The root dir of gaia repo is not available in the docs

Copy link
Contributor

Choose a reason for hiding this comment

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

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Let's do that for future releases after the docs refactor

MSalopek and others added 11 commits March 19, 2024 13:27
Co-authored-by: Marius Poke <marius.poke@posteo.de>
Co-authored-by: Stana Miric <stana.miric@ethernal.tech>
Co-authored-by: Stana Miric <stana.miric@ethernal.tech>
Co-authored-by: Dusan Maksimovic <94966669+dusan-maksimovic@users.noreply.github.com>
Co-authored-by: Dusan Maksimovic <94966669+dusan-maksimovic@users.noreply.github.com>
Co-authored-by: Dusan Maksimovic <94966669+dusan-maksimovic@users.noreply.github.com>
Co-authored-by: Dusan Maksimovic <94966669+dusan-maksimovic@users.noreply.github.com>
Co-authored-by: Dusan Maksimovic <94966669+dusan-maksimovic@users.noreply.github.com>
@MSalopek MSalopek merged commit 0192205 into main Mar 19, 2024
9 checks passed
@MSalopek MSalopek deleted the masa/more-v47-docs branch March 19, 2024 13:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S: KTLO Keeping the lights on: Keeping the current product operational (bugs, troubleshooting, deps updates) scope: docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

update docs after upgrading to cosmos-sdk v47 and ibc-go v7
4 participants