Open Nlight91 opened 2 days ago
Markdown and some form of Doxygen/Javadoc style annotations are pretty widespread conventions in several languages already, improving the flow for editing those does sound nice.
improving the flow for editing those does sound nice.
You got it, that's exactly that ! thank you
Check for existing issues
Describe the feature
Concept
There are existing projects that scans other project and auto-build a documentation, my suggestion is to pick one of them (or more tedious, create one) and use it in a fully integrated way.
However, that is not all, the main concept that led me here, is that opening and editing the documentation of a library, function, class and methods that we are currently working on be accessible with just a combination of modifiers+(key || mouse button) press.
would it open a editing popup, or appear in a split is to be determined. For the documentation formatting language, I suggest Markdown. For the "doc editor window", it should offer IMO a wysiwyg mode by default with the focused line/paragraph being raw Markup, and also offer a raw Markdown mode.
Benefits
Not only it would favor a good documentation, a thing still often neglected. but it would also promote :
If applicable, add mockups / screenshots to help present your vision of the feature
No response