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

2503 doc autogen w/ commit signature #2570

Merged
merged 14 commits into from
Jan 30, 2025
Merged

2503 doc autogen w/ commit signature #2570

merged 14 commits into from
Jan 30, 2025

Conversation

owenwahlgren
Copy link
Collaborator

A fresh PR for #2539 as signing commit history and rebasing got annoying

@owenwahlgren owenwahlgren added the documentation Improvements or additions to documentation label Jan 23, 2025
@owenwahlgren owenwahlgren self-assigned this Jan 23, 2025
@owenwahlgren owenwahlgren requested a review from a team as a code owner January 23, 2025 16:59
@owenwahlgren owenwahlgren mentioned this pull request Jan 23, 2025
@sukantoraymond sukantoraymond added this to the Documentation milestone Jan 23, 2025
@owenwahlgren
Copy link
Collaborator Author

owenwahlgren commented Jan 24, 2025

added /sdk doc generation per #2523

please provide feedback 🙏 there probably needs to be more concrete examples?

@meaghanfitzgerald
Copy link
Collaborator

@sukantoraymond please review the sdk documentation

@meaghanfitzgerald meaghanfitzgerald mentioned this pull request Jan 27, 2025
This was linked to issues Jan 27, 2025
## Table of Contents

- [blockchain](#blockchain)
- [constants](#constants)
Copy link
Collaborator

Choose a reason for hiding this comment

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

I don't think we need to list every single SDK that we have.
I think we just need to list the main ones:

  • Blockchain
  • Interchain
  • Validator
  • Validator Manager
  • Interchain

Copy link
Contributor

Choose a reason for hiding this comment

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

Why don't we want to document the other stuff? I believe we should document everything there is, especially if it's autogenerated. This way the AI we are training on the docs gets more context on all these topics

Copy link
Collaborator

@meaghanfitzgerald meaghanfitzgerald left a comment

Choose a reason for hiding this comment

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

Approving and merging this PR so that the updated CLI commands go live on the docs site. We should create a new branch to work on the needed updates for the SDK docs ref:#2570 (comment)

@martineckardt
Copy link
Contributor

Yes, let's get the first version out and then we can iterate on that

@arturrez arturrez merged commit 4d7708c into main Jan 30, 2025
@arturrez arturrez deleted the 2503-doc-autogen-fresh branch January 30, 2025 18:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: Done ✅
Development

Successfully merging this pull request may close these issues.

SDK Documentation Doc Autogen
5 participants