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

[chainctl] Improve chainctl docs organization, add some general guidance docs #777

Open
SharpRake opened this issue Jun 14, 2023 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation enforce enhancement New feature or request icebox Frozen issues that can be thawed

Comments

@SharpRake
Copy link
Collaborator

SharpRake commented Jun 14, 2023

Is your feature request related to a problem? Please describe.
Our chainctl docs are a bit of a confusing mess these days. Per a quote Kim shared:

"I don't see anything (for schema or docs on the config). I gotta be honest I do find the docs a little hard to navigate. There are auto generated docs for all the commands but we don't have an overview page for chainctl that I can find"

Describe the solution you'd like
What if we had some overarching chainctl docs? I feel like we could highlight some general usage in a few short tutorials. It might take some finagling to reorganize the autodocs but if it makes chainctl more useful, that would be awesome for us.

Describe alternatives you've considered
I've not considered any alternatives and would be very welcome to any ideas.

Additional context
This issue came from this comment from Kim in another issue.
@jamonation I'm looping you in b/c of the autodocs and because I think you'd be a great thinking partner on this (when you're back from vacation and settled of course)

@SharpRake SharpRake added documentation Improvements or additions to documentation enhancement New feature or request Q3 2023 Project Candidate Q3 2023 Project enforce labels Jun 14, 2023
@ltagliaferri ltagliaferri changed the title Improve chainctl docs organization, add some general guidance docs [chainctl] Improve chainctl docs organization, add some general guidance docs Sep 5, 2023
@SharpRake
Copy link
Collaborator Author

Moving to backlog for now

@ltagliaferri
Copy link
Collaborator

This is a nice to have but will be hard to modify this based on current automated workflows. We do have an overview page on chainctl which is linked at the top of the chainctl landing page.

@ltagliaferri ltagliaferri added icebox Frozen issues that can be thawed and removed Q4 2023 Project labels Nov 13, 2023
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 enforce enhancement New feature or request icebox Frozen issues that can be thawed
Projects
None yet
Development

No branches or pull requests

3 participants