Skip to content

Readme File / Local Build Instructions #23

Open
@SamJUK

Description

@SamJUK

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or requesthelp wantedExtra attention is needed

    Type

    No type

    Projects

    Status

    📋 Backlog

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions