janhoy opened a new pull request, #4271: URL: https://github.com/apache/solr/pull/4271
This is a WIP POC for auto generating CLI ref-guide docs for the new picoCli instrumented tools. The docs are auto generated using [PicoCLI's `ManPageGenerator`](https://picocli.info/man/gen-manpage.html), one ref-guide page per tool. Menus are also updated, and tools are cross-linked. The existing landig page "Solr Control Script Reference" is reduced from a huge all-in-one page to an overview page that introduces the CLI and links to the generated man-pages. This way, our docs will always stay in sync with the actual `@picocli` annotations in the code. There are two gradle tasks added in this PR: * `generateCliDocs` - Regenerate CLI reference pages in pages/cli/ from picocli annotations. * `checkCliDocsUpToDate` - Verify that pages/cli/ CLI docs are in sync with picocli annotations - runs on check Screenshot: <img width="1281" height="798" alt="Skjermbilde 2026-04-08 kl 12 12 01" src="https://github.com/user-attachments/assets/aa3388f5-bcb8-429f-ac1d-7cf60f10bca8"; /> This is a draft, mostly AI generated, not reviewed in full. Need discussion about how we want the docs to be. https://issues.apache.org/jira/browse/SOLR-17697 -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
