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.

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

Readme File / Local Build Instructions #23

Open
SamJUK opened this issue Oct 21, 2024 · 0 comments
Open

Readme File / Local Build Instructions #23

SamJUK opened this issue Oct 21, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed

Comments

@SamJUK
Copy link
Contributor

SamJUK commented Oct 21, 2024

Currently, as far as I can tell, there is no README or document that outlines how contribute to the docs / build the project locally.

Whilst its fairly simple to get started if you have used Sphinx before, it adds additional complexity for newcomers to the project/Sphinx to contribute.

Adding a light README file with the following to the repo should help lower the barrier for contribution.

  • What this repo contains, and where the end project can be found (Warden Dev Docs at https://docs.warden.dev/)
  • What technologies are used to build the docs (Sphinx)
  • Local Build Instructions pip install -r requirements.txt && make html && python -m http.server -d _build
@navarr navarr added documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed labels Oct 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed
Projects
Status: 📋 Backlog
Development

No branches or pull requests

2 participants