Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Open
yashlamba opened this issue Jan 12, 2022 · 2 comments
Open

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

yashlamba opened this issue Jan 12, 2022 · 2 comments

Comments

@yashlamba
Copy link
Member

No description provided.

@Vaibhav-Chopra-GT
Copy link
Contributor

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?

@yashlamba
Copy link
Member Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@yashlamba @Vaibhav-Chopra-GT