News for hackers. Stuff that matters.
Re:Writerside – a new technical writing environment from Jet... by rob74 on Tuesday October 24, 2023 @02:20AM (#37995365)
Markdown and XML are nice, but what about more advanced documentation formats like OpenAPI? For one recent project, I set up automatic generation of the OpenAPI docs from (much more compact and flexible) CUE definitions (https://cuelang.org/) - which has the bonus of also being able to test the API against the definitions. JetBrains has a CUE plugin, but it's really barebones (doesn't even support jumping from the usage of a schema to its definition). Of course the possibilities when generating docs are endless - just think of the various syntaxes for doc comments, embedding examples/tests in source code etc., and each language tends to have its own standard (either built in or third party).
Re:Writerside – a new technical writing environment from Jet... by lananovikova on Tuesday October 24, 2023 @04:37PM (#38005177)