In the repo, readme. Mostly.
Each of my repos have an overview, installation, execution, testing, and deployment sections.
I include images or links to Lucid for architecture diagrams.
Sometimes I put readme into subdirectories as well if I think it’s warranted. (Rare)
I really like markdown. It’s a great format for sharing information for technical folks especially newcomers to the code.
As for documenting code itself, I try my best to write simple, clear, self explanatory code with good naming. All of my functions are single responsibility. Everything is clean and organized whether it’s structs or classes.
I rarely write comments in code unless it’s for autodoc’ing library code.
Not sure if this is what you were asking for - let me know if you mean something else. Interested to know more.
Each of my repos have an overview, installation, execution, testing, and deployment sections.
I include images or links to Lucid for architecture diagrams.
Sometimes I put readme into subdirectories as well if I think it’s warranted. (Rare)
I really like markdown. It’s a great format for sharing information for technical folks especially newcomers to the code.
As for documenting code itself, I try my best to write simple, clear, self explanatory code with good naming. All of my functions are single responsibility. Everything is clean and organized whether it’s structs or classes.
I rarely write comments in code unless it’s for autodoc’ing library code.
Not sure if this is what you were asking for - let me know if you mean something else. Interested to know more.