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

Auto generate cli docs #71

Merged
merged 74 commits into from
Feb 6, 2023
Merged

Auto generate cli docs #71

merged 74 commits into from
Feb 6, 2023

Conversation

DJSanti
Copy link
Contributor

@DJSanti DJSanti commented Jan 11, 2023

What was changed

A program that extracts information about the commands and converts it to Markdown files. This would then be exported to the documentation team to use as source docs for their purposes.

Why?

Saves time on figuring out the intricacies of each command.
Keeps information updated as the main branch changes.

Checklist

  • Link or download generated documents to /documentation
  • Atomize options
  • Link to Temporal terms mentioned in the text
  • Include additional information and code samples
  • Create frontmatter
    Note: already created program that breaks down the markdown-converted application into separate files and directories, with basic Markdown formatting.

How was this tested:

I iterated each step of this program. I can confirm that it will work whether a /docs folder exists or not. It will continue to update what's present.

Any docs updates needed?

YES.
Docs team is going to download these files and use them to generate pages for the website.


Any feedback to the code, especially where additional information needs to be added for docs, would be greatly appreciated. I'm pretty new to Go and don't know how to advance from this point beyond creating more manual work in the docs repo.

UPDATE: program is nearly complete. Just needs additional text in UsageText and it will fully generate docs. And, also, linking up to docs repo.

@DJSanti DJSanti self-assigned this Jan 25, 2023
@DJSanti DJSanti added the documentation Improvements or additions to documentation label Jan 25, 2023
cmd/doc/main.go Outdated Show resolved Hide resolved
@feedmeapples feedmeapples self-requested a review February 2, 2023 18:36
Copy link
Contributor

@flossypurse flossypurse left a comment

Choose a reason for hiding this comment

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

OK, looking good to me.

As long as @feedmeapples is good with it!

@DJSanti
Copy link
Contributor Author

DJSanti commented Feb 3, 2023

Changed links for linkmagic

@DJSanti DJSanti merged commit e4354fb into main Feb 6, 2023
@DJSanti DJSanti deleted the auto-generate-cli-docs branch February 6, 2023 15:31
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
None yet
Development

Successfully merging this pull request may close these issues.

4 participants