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: render orm and collections in docs #15736

Merged
merged 15 commits into from
Apr 8, 2023
Merged

Conversation

julienrbrt
Copy link
Member

@julienrbrt julienrbrt commented Apr 7, 2023

Description

Now that both ORM and Collections docs are ready, add a packages section that renders the documentation for ORM and Collections.
Moves depinject documentation under that package section and setup redirects to not break links.
Add redirects about the capability module now that it lives in IBC (https://github.com/cosmos/ibc-go/tree/fdd664698d79864f1e00e147f9879e58497b5ef1/modules/capability)

After this section, we have:

  • under /packages a list of all our packages (orm, collections, log, math, ...) - anything cosmossdk.io/*
  • under /tools a list of all our tooling - anything under cosmossdk.io/tools/*
  • under /modules section, once everything is extracted, is as well a list of cosmossdk.io/x/*

Inspired from https://golang.org/x page.


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 7, 2023 11:30
@github-prbot github-prbot requested review from a team and mark-rushakoff and removed request for a team April 7, 2023 11:31
Copy link
Member

@tac0turtle tac0turtle left a comment

Choose a reason for hiding this comment

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

packages is a bit if a weird name. I dont think adding another section like this is worth it. Can we add collections and orm to building modules and depinject to building apps

@julienrbrt
Copy link
Member Author

packages is a bit if a weird name. I dont think adding another section like this is worth it. Can we add collections and orm to building modules and depinject to building apps

I was thinking of using this section for rendering as well, math, log, and all other helpful package README. Don't you think it's worth it?

Copy link
Member Author

@julienrbrt julienrbrt Apr 7, 2023

Choose a reason for hiding this comment

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

Improved it a bit, wdyt @tac0turtle? If we are exhaustive, then it makes sense imho.
Not extremely fan of the term Automation but I couldn't come up with better. It does make it sound cool.

Copy link
Member

Choose a reason for hiding this comment

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

Packages is a go term so i guess it makes sense. Its not the most appealing but maybe we come up with something in the future

@julienrbrt julienrbrt enabled auto-merge (squash) April 8, 2023 10:17
@julienrbrt julienrbrt merged commit 117a426 into main Apr 8, 2023
@julienrbrt julienrbrt deleted the julien/package-section branch April 8, 2023 10:18
@julienrbrt julienrbrt mentioned this pull request Apr 8, 2023
22 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants