Make Projects Documentation a fabulous experience

[Nlight91]

Check for existing issues

• Completed

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 :

• a documentation organization standard, which if does spread wide enough throughout the industry, would greatly facilitate their consultation, out of habit.
• an ease for development, as one could consult the docs of whatever code portion he's working on and dismiss it with ease, which can be mandatory for complex projects. Allowing switching between reading/editing docs and editing code a fast and accessible process, makes the doc writing an incremental task done almost at the same time as writing the code, somewhat mimicking how the brain works, as it quickly navigates tasks all the time, in a non sequential way.

If applicable, add mockups / screenshots to help present your vision of the feature

No response

[jansol]

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.

[Nlight91]

improving the flow for editing those does sound nice.

You got it, that's exactly that ! thank you

[notpeter]

In the absence of specific actionable suggestions for improving the experiencing of writing project documentation I'm going to convert this to a discussion.

As someone who writes a lot of markdown documentation in Zed about Zed, I'd be very excited for suggestions on how to improve that process. Thanks for reporting.

[ryanwwest]

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.

This for Markdown, and support for adjustable line heights/image/hiding link syntax of e.g. Markdown when cursor isn't directly over it would be great for editing documentation, even without doing anything else. And just good in general - that would open up so many possibilities.

Basically the equivalent of Obsidian's Live Preview mode. I think a good deal of people would move over to Zed for their PKM/Zettelkasten systems if Markdown and other formats could be written and read nicely without a dual view of source/preview.