handwrite icon indicating copy to clipboard operation
handwrite copied to clipboard

docs: contributing: Add docs on how to build docs locally

Open yashlamba opened this issue 4 years ago • 2 comments

yashlamba avatar Jan 12 '22 17:01 yashlamba

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 or mkdocs build or both?

I also couldn't find a link to the deployed documentation website. Could you please provide me the link?

Vaibhav-Chopra-GT avatar Jan 24 '22 19:01 Vaibhav-Chopra-GT

Hi @Vaibhav-Chopra-GT, you can go ahead!

  1. Yes, see https://www.builtree.org/simulate/contributing/ for reference.
  2. You can refer the docs above

Deployed docs: main/released dev

yashlamba avatar Jan 26 '22 15:01 yashlamba