From 335e21c4c50dfb5c74a04fb21d91f3556b4575b5 Mon Sep 17 00:00:00 2001 From: hasezoey Date: Mon, 14 Nov 2022 13:50:11 +0100 Subject: [PATCH] docs(CONTRIBUTING): add section for documentation style guidelines re #12645 --- CONTRIBUTING.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9c7897da3b8..75c0ae02404 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -59,6 +59,12 @@ If you'd like to preview your documentation changes, first commit your changes t Visit `http://localhost:8089` and you should see the docs with your local changes. Make sure you `npm run docs:clean` before committing, because automated generated files to `docs/*` should **not** be in PRs. +#### Documentation Style Guidelines + +There are some guidelines to keep the style for the documentation consistent: + +- All links that refer to some other file in the mongoose documentation needs to be relative without a prefix unless required (use `guide.html` over `./guide.html` or `/docs/guide.html`) + ### Plugins website The [plugins](http://plugins.mongoosejs.io/) site is also an [open source project](https://github.com/vkarpov15/mongooseplugins) that you can get involved with. Feel free to fork and improve it as well!