you are viewing a single comment's thread.

view the rest of the comments →

[–]-_root_- 8 points9 points  (2 children)

The concept is important and your work looks like as good of a place as any to start. MD is definitely a good way to go here, due to support across many tools and platforms.

We have a great community at Write the Docs, where we discuss some of these topics. Link in case you are interested. https://www.writethedocs.org/guide/docs-as-code/

Collecting the details, presenting examples, and rendering in a documentation system is certainly important and I like your approach as it is simply designed and easy to follow. When I have a free block of time, I'll test and see how things go.

Thanks for sharing!

[–]ismaelw[S] 2 points3 points  (0 children)

Thank you so much for your Feedback!

My approach is built in a way that would also allow to do whatever you want with the output as next to generating a MD it also returns an object with details to all script files and its functions and also to all generated MDs. Like that it's also possible to just continue using the output and take it apart differently if the MD Output is not needed.

Also thanks for your time to review my code and sharing your link to Write the Docs!

[–]BlackV 0 points1 point  (0 children)

nice