Hacker News new | ask | show | jobs
by octo-andrero 640 days ago
Could you share any examples of interactive documentation or tools to build interactive documentations? The only thing comes to my mind is Swagger / OpenAPI documentation pages from Spring that allows you to send the request.
1 comments

* A terminal command just for displaying documentation on all other supported terminal commands by the application. Then more detailed documentation for each specific command with examples. Finally, a validation engine that allows per character validation of terminal input, as in a REPL.

* Similar input characteristics for a web-based interface.

* Documentation search function and/or auto-complete

Thank you!