Welcome to the world of development, where your code not only speaks for itself but also relies on well-crafted documentation to shine. For junior ...
For further actions, you may consider blocking this person and/or reporting abuse
In previous years, when I have used C# and .Net, I always used Sandcastle to generate MS-style documentation for my code. I would also use jsdoc for JavaScript and generate something roughly the same. Is there a location for this type of documentation, or is best practice to just use the markdown?
Thank you for bringing up this great point about documentation generators! While Sandcastle and JSDoc are excellent tools for generating API documentation from code comments, GitHub repositories typically handle documentation in different layers:
Code Documentation (API docs)
Repository Documentation (what my article focuses on)
You can actually use both approaches! A common pattern is:
docsfolder)This gives you the best of both worlds: easily maintainable markdown files for project documentation and comprehensive API documentation for developers.
Mildly disappointed but then I'm not a junior developer so that's on me 😉.
But the reason is that I clicked in hoping to find some mention of the ubiquitously encountered readthedocs documentation site that FOSS products and github projects lean on (because I've been too busy/lazy/distracted to bother looking into that myself yet - so a 2 minute primer on my feed would lure me).
Absolutely, Bernd. Point taken about missing out on Read the Docs. It's a key piece for anyone in the FOSS and GitHub scene, for sure. Appreciate the nudge! We'll keep in mind to dive into those essential tools a bit more in the future. Thanks for the heads-up! 😉
This is a great summary! Thank you!!
Super glad you liked it. 😊 If there's anything else you're curious about, just shout. More cool stuff coming your way!
Thanks for you kindness. I am a beginner. I'm still learning.