From 7704cc9d45c91f8202ff25861aa86c7a4c3fd3fa Mon Sep 17 00:00:00 2001 From: James Braza Date: Sat, 20 Jan 2024 11:40:26 -0800 Subject: [PATCH] Added CONTRIBUTING.md explaining how to make docs PRs --- CONTRIBUTING.md | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..a4baf8e5 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,11 @@ +# Contributing + +## Documentation + +There are a few places the documentation lives: + +- Actual source: [`MANUAL.markdown`](MANUAL.markdown) +- Autogenerated sources (using `pandoc`): HTML files in `docs/`, [`MANUAL`](MANUAL) + +Once you have edited `MANUAL.markdown`, +regenerate the documentation by running `make doc`.