4 ms·
It would be nice to put some examples: code and generated documentation, so potential users may be more eager to try the product. Currently, the website is not
by piterrro 3y ago
It would be nice to put some examples: code and generated documentation, so potential users may be more eager to try the product.
Currently, the website is not very descriptive and I'm not sure what I would be getting in return and I don't want to give away my code already.
Another thing is, you picked a tough problem to solve. A handy documentation draws the context of decisions made that resulted in features. Documenting *just the code* will never be enough as it's like summarizing what is already written.
Documentation should explain and help understand why things work this way, which I truly believe cannot be enclosed within the code from which automatic documentation is generated.