Re:Technical documentation that just works
by squidfunk on Thursday May 27, 2021 @02:59AM
(#27300199)
Author here, AMA!
[ Parent
| on HN ]
Re:Technical documentation that just works
by mihemihe on Thursday May 27, 2021 @06:37AM
(#27301288)
Do you have some examples, showcase or demo somewhere to see the actual final result? Thanks
Re:Technical documentation that just works
by squidfunk on Thursday May 27, 2021 @07:30AM
(#27301712)
Sure! The README links [1] to several installations used by large Open Source projects and companies. Some prominent examples:
- https://fastapi.tiangolo.com/
- https://crystal-lang.org/reference/
- https://mozillafoundation.github.io/engineering-handbook/
- https://microsoft.github.io/code-with-engineering-playbook/
[1]: https://github.com/squidfunk/mkdocs-material#trusted-by-
Re:Technical documentation that just works
by united893 on Thursday May 27, 2021 @03:15AM
(#27300280)
Is this g3doc?