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: simplifying categories #15757

Merged
merged 5 commits into from
Apr 10, 2023
Merged

docs: simplifying categories #15757

merged 5 commits into from
Apr 10, 2023

Conversation

julienrbrt
Copy link
Member

@julienrbrt julienrbrt commented Apr 8, 2023

Description

After #15736, I was looking at the different categories existing to see if they make sense.

  • The spec category contains duplicate and unnecessary information. This PR removes unnecessary pages and adds redirects.
  • The ecosystem page was redundant with the module overview README. This PR removes it and adds a redirect.
  • Updates support link to GH discussion

What do you think?


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 type prefix in the PR title
  • added ! to the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • followed the guidelines for building modules
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • included comments for documenting Go code
  • updated the relevant documentation 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 type prefix in the PR title
  • confirmed ! in the type prefix if API or client breaking change
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic
  • reviewed API design and naming
  • reviewed documentation is accurate
  • reviewed tests and test coverage
  • manually tested (if applicable)

@julienrbrt julienrbrt requested review from tac0turtle and a team as code owners April 8, 2023 10:59
@github-actions github-actions bot added C:Cosmovisor Issues and PR related to Cosmovisor C:x/distribution distribution module related labels Apr 8, 2023
@github-prbot github-prbot requested review from a team and samricotta and removed request for a team April 8, 2023 10:59
* [Chain Setup](#chain-setup)
* [Prepare Cosmovisor and Start the Chain](#prepare-cosmovisor-and-start-the-chain)
* [Update App](#update-app)
* [Design](#design)
Copy link
Member Author

Choose a reason for hiding this comment

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

this was not rendered properly in the docs due to the spacing.

@julienrbrt julienrbrt added the T:Docs Changes and features related to documentation. label Apr 8, 2023
sidebar_position: 1
---

# Ecosystem
Copy link
Member

Choose a reason for hiding this comment

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

we should make an issue to build a larger ecosystem page on the docs website.

Copy link
Member Author

Choose a reason for hiding this comment

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

Agree, but isn't it what awesome-cosmos or https://cosmos.network/ecosystem ought to be?

What the ecosystem page from the Cosmos SDK should look like? The way we had it was duplicating content.


Read more about writing smart contracts with CosmWasm at their [documentation site](https://book.cosmwasm.com/), or visit [the repository](https://github.com/CosmWasm/cosmwasm).

## EVM
Copy link
Member

Choose a reason for hiding this comment

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

where is this mentioned now?

Copy link
Member Author

Choose a reason for hiding this comment

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

It was already mentioned in x/README.md

@tac0turtle tac0turtle merged commit 1078369 into main Apr 10, 2023
@tac0turtle tac0turtle deleted the julien/specs branch April 10, 2023 11:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C:Cosmovisor Issues and PR related to Cosmovisor C:x/distribution distribution module related T:Docs Changes and features related to documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants