Skip to content

Commit

Permalink
docs: update the readme for refresh commands (#408)
Browse files Browse the repository at this point in the history
Signed-off-by: Terry Howe <[email protected]>
  • Loading branch information
TerryHowe authored Nov 5, 2024
1 parent 21abfa0 commit 7057f94
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,14 @@ use:
npm run serve
```

## Generated Command Pages

Do not manually modify files in `versioned_docs` directory because they are generated from the command help text.
If there are changes needed in the command documentation, make fixes to the command help text.
When you run the build, `npm run refresh-commands` is run to update the files.
If any of the files are out of date, they will show up as modified.
See the comments in `tools/refresh-commands.sh` for more details.

## Code of Conduct

This project has adopted the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md). See [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) for further details.
Expand Down

0 comments on commit 7057f94

Please sign in to comment.