docs: contributing: Add docs on how to build docs locally
Opened this issue · 2 comments
yashlamba commented
docs: contributing: Add docs on how to build docs locally
Vaibhav-Chopra-GT commented
Can I work on this? I had some questions -
- Should this be added in the contributing section of the documentation as a new subheading (making it
Linux
,Windows
,Building documentation locally
) or should I add a new point in both of the installations stating how to build the docs? - Which commands should I add for the documentation?
mkdocs serve
ormkdocs build
or both?
I also couldn't find a link to the deployed documentation website. Could you please provide me the link?
yashlamba commented
Hi @Vaibhav-Chopra-GT, you can go ahead!
- Yes, see https://www.builtree.org/simulate/contributing/ for reference.
- You can refer the docs above
Deployed docs:
main/released
dev