Skip to content

Commit 5e3ffe0

Browse files
committed
docs: document docs generation workflow
1 parent bf11d64 commit 5e3ffe0

1 file changed

Lines changed: 18 additions & 0 deletions

File tree

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -532,6 +532,24 @@ kfutil stores inventory remove \
532532
533533
## Development
534534
535+
### Regenerating documentation
536+
537+
The command reference and generated use-case docs are checked into this repository. Regenerate them after changing CLI
538+
commands, flags, embedded store type metadata, or embedded PAM type metadata:
539+
540+
```bash
541+
go run . makedocs
542+
```
543+
544+
This updates:
545+
546+
- `docs/kfutil*.md` command reference pages
547+
- `docs/use-cases/Certificate Store Operations/Store Types/*.md`
548+
- `docs/use-cases/PAM Operations/*.md`
549+
550+
The store type and PAM operation docs are generated from `cmd/store_types.json` and `cmd/pam_types.json`. The generated
551+
command docs intentionally omit date-based generator footers to avoid unrelated documentation churn.
552+
535553
This CLI developed using [cobra](https://umarcor.github.io/cobra/)
536554
537555
### Adding a new command

0 commit comments

Comments
 (0)