nprasad2077/docs
1
1 Fork 0
mirror of https://gitea.com/gitea/docs.git synced 2026-11-06 10:00:32 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: drop the generated gt reference

Browse Source 
The per-command reference made the pages long and repeated what
gt <command> --help shows. Keep the guides and remove the generator,
its workflow and the sidebar handling it needed.

Signed-off-by: bircni <[email protected]>
This commit is contained in:
bircni committed 2026-10-22 18:31:31 +02:00
1 parent 011651ad16
commit 540757fe56
264 files changed
+11 -15121
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

README.md
+2 -16
View File
@@ -131,22 +131,8 @@ The documentation of `gt`, the Gitea CLI from
No series is documented yet. Once a release exists, cut its series with
`make cut-version PRODUCT=cli VERSION=0.1`, then list it in `cliSeries` in
`packages/content-loader/src/products.ts`; the develop docs then move to
`/cli/develop/`. Its sidebar is written by hand in `cli-sidebars.js`, apart from
the reference, which is laid out from its directory tree.
The pages under `reference/` are generated with gt's own generator
(`go run ./tools/cli-docs`), one page per command and help topic, with a command
that has subcommands turned into a directory:
```shell
make update-cli-docs # develop docs, from the main branch of gitea/cli
make update-cli-docs-released # every series, from its newest stable tag
./update_cli_docs.sh v0.1.0 cli-docs_versioned_docs/version-0.1/reference
```
`CLI_REMOTE` points the script at another clone, such as a local checkout. The
`update cli reference` workflow refreshes the pages weekly, like the runner's.
Generating them needs Go.
`/cli/develop/`. Its sidebar is written by hand in `cli-sidebars.js`. The
guides do not repeat every flag: `gt <command> --help` documents each command.
## Deployment