diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000000000000000000000000000000000000..7ee2911d6ec6ff79c9cfe4eb7133995d59b1a8a1 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,23 @@ +# How to contribute + +This documentation is built with Hugo plus Hyas. + +To build locally: + +```bash +npm install +npm run build +``` + +To contribute some changes: + +* work on a branch +* make your changes (usually inside `content/`) +* check how your changes look by running `npm run dev` and pointing + your browser at the web servers it creates +* once you're done, `npm run lint` to check your formatting +* commit, push, open a MR on the GitLab + +A word about the `weight:` attribute of pages: it's used to sort pages +for the "next" / "prev" links at the bottom. If you add a new page, +make sure it's slotted in a sensible place in that order. diff --git a/README.md b/README.md index bed543c6ea34f9e61cce2af35b9129f747699f2f..e51d7c77282dc46f3aec0abfe70c7e388c0269fd 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,6 @@ # Documentation -TBD +This is the documentation repository for the Sharkey project, see +https://activitypub.software/TransFem-org/Sharkey/ + +It's published at https://docs.joinsharkey.org/