Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
36 lines (26 loc) · 1.63 KB

CONTRIBUTING.md

File metadata and controls

36 lines (26 loc) · 1.63 KB
Raw

Contributing to range42-docs

Workflow

  1. Edit — modify or add .md files under docs/.
  2. Preview — run npm start and check your changes at http://localhost:3000.
  3. Offline build check — before opening a PR, run npm ci && npm run build to catch broken links and MDX errors (onBrokenLinks is set to throw).
  4. PR — open a pull request into main with a clear description of what changed and why.
  5. Review — a maintainer reviews the content for accuracy, style, and site integrity.
  6. Auto-deploy — merges to main trigger the GitHub Actions workflow that publishes to GitHub Pages at https://docs.range42.lu.

Style guidelines

  • Write in plain, direct English. Avoid marketing language.
  • Use fenced code blocks with language identifiers.
  • Prefer relative links between docs pages ([title](./path)).
  • Keep frontmatter minimal: id, title, sidebar_position where needed.
  • Escape bare < and { characters in prose (MDX compiles all .md files).

Commits

Follow Conventional Commits:

docs: fix typo in getting-started/install-wizard
docs: add troubleshooting entry for vault password errors

Do not include AI tool names, "Generated by", or any attribution to AI systems in commit messages, PR descriptions, code comments, or any other artifact.

Adding a new doc page

  1. Create the .md file under docs/ (or a subdirectory).
  2. Add frontmatter with at least id and title.
  3. Register it in sidebars.js at the appropriate position.
  4. If the page should appear in a versioned snapshot, cut a new version after merging (see README).