All contributions are very welcome and appreciated! Ways to contribute include:
- Improving existing content on the website: extending or clarifying descriptions, adding relevant references, diagrams, etc.
- Providing feedback on existing content
- Proposing new topics for inclusion on the website, and writing the content for them
- ... and anything else you consider useful!
This repository provides a devcontainer.
Instructions to install this feature and start the devcontainer can be found for:
- VSCode: https://code.visualstudio.com/docs/devcontainers/containers
- Github CodeSpace: https://docs.github.com/en/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers
- JetBrains: https://www.jetbrains.com/help/idea/start-dev-container-inside-ide.html
The devcontainer automatically launches an HTTP server on port 8080 and serving the live-built documentation: http://localhost:8080/
To build previews of the documentation locally, start by installing
uv. This will give you the uvx command,
which is an alias for uv run.
Now you can build the docs like this:
uvx --with-requirements requirements.txt mkdocs buildor build the docs locally and serve them over local HTTP:
uvx --with-requirements requirements.txt mkdocs serveEveryone interacting in the WheelNext project's codebases, issue trackers, and communication channels is expected to adhere to the NumFOCUS Code of Conduct.