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: improve commands generation #1446

Merged
merged 7 commits into from
Dec 21, 2023
Merged

docs: improve commands generation #1446

merged 7 commits into from
Dec 21, 2023

Conversation

cfabianski
Copy link
Collaborator

@cfabianski cfabianski commented Dec 21, 2023

Description

closes #1410 #1245

Improve the doc generation.
I needed to have an accessor to the env variables defined in viper so I forked Viper and I made those changes spf13/viper@f9bd0ac

Another approach would have been not rely on the Cobra commands at all and instead use only the code and Flags we defined ourselves.
I discarded this option as I wanted my changes to be portable to Cobra, Viper, PFlags if we wanted.

image

Checklist

  • I've added test coverage that shows my fix or feature works as expected.
  • I've updated or added documentation if required.
  • I've included usage information in the description if CLI behavior was updated or added.
  • PR title follows Conventional Commits format

@cfabianski cfabianski force-pushed the improve-documentation branch from 001bcd8 to 3caee3a Compare December 21, 2023 09:27
@cfabianski cfabianski marked this pull request as ready for review December 21, 2023 09:31
@cfabianski cfabianski merged commit f493379 into main Dec 21, 2023
8 checks passed
@cfabianski cfabianski deleted the improve-documentation branch December 21, 2023 12:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Hidden flags are shown in the documentation
2 participants