infix icon indicating copy to clipboard operation
infix copied to clipboard

Add documentation to Infix image for CLI/Web

Open troglobit opened this issue 1 year ago • 2 comments

  • Include all documentation in the image
  • Add CLI keywords man and apropos (alias search maybe?)
  • Allow bringing up and searching from anywhere in the CLI
admin@example:/config/interface/eth0/ipv4/> search ipv4ll
networking: Setting up IPv4 link-local address
...

troglobit avatar Sep 16 '24 07:09 troglobit

Looks like https://www.sphinx-doc.org/ may be the best alternative to tie it all together with. It can read both traditional .rst (restructured text) format and .md (commonmark format with lots of extensions), meaning we write the glue logic in .rst files and keep all existing .md files as-is.

Possibly we should move to .rst for test documentation as well.

troglobit avatar Feb 05 '25 12:02 troglobit

Another, very interesting, alternative is Material for MkDocs, which aims to always be compatible with GHFM (GitHub Flavored Markdown). Meaning, we can retain the current "just works" browsing of documentation via the GitHub interface, and from the same sources generate documentation for multiple targets.

troglobit avatar Jun 27 '25 13:06 troglobit