https://github.com/getwilds/guide
WILDS Dev Guide
https://github.com/getwilds/guide
documentation
Last synced: 10 months ago
JSON representation
WILDS Dev Guide
- Host: GitHub
- URL: https://github.com/getwilds/guide
- Owner: getwilds
- License: cc0-1.0
- Created: 2023-10-18T17:41:26.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-03-11T20:08:56.000Z (over 1 year ago)
- Last Synced: 2025-03-14T19:35:30.681Z (over 1 year ago)
- Topics: documentation
- Language: Lua
- Homepage: https://getwilds.org/guide/
- Size: 2.38 MB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Changelog: Changelog.md
- Contributing: contributing.qmd
- License: LICENSE.md
Awesome Lists containing this project
README
# WILDS Contributor Guide
Contributor guide for the WILDS GitHub organization at Fred Hutch Data Science Laboratory.
## Contributing to this guide
On the command line `make` commands are provided in the `Makefile` in this repo, with the following two commands:
- `make preview`
- `make render`
You can contribute via other editors/IDEs - see https://quarto.org/
## Publishing
The book is published on each push to main using the GitHub Actions workflow in `.github/workflows/publish.yml`. There's no need to do anything other than push (or merge/etc) to the `main` branch to update the public version of this book. Note that the book will only be updated by changes on `main` - so we're free to make changes on other branches without affecting the public version. We may want to change this flow in the future - e.g., require a pull request to `main` rather than push directly to make sure there's some review.