Getting Started

What you need

• A copy of this repository on your computer
• Node.js LTS
• Any text editor you like

VS Code is a good choice if you want a simple editor with a file list and Markdown support.

Install Node.js if needed

If Node.js is not already installed on your machine:

• macOS: install it from nodejs.org or with Homebrew using brew install node
• Windows: install it from nodejs.org
• Linux: install it with your package manager or from nodejs.org

You can verify the install with:

node --version
npm --version

Start the preview

Use the script that matches your operating system:

• macOS: ./start-docs.command
• Windows: .\start-docs.bat
• Linux: ./start-docs.sh

On macOS and Windows, you can double-click the script if that feels easier. The first run will install the docs tools for you.

When the preview is ready, open http://localhost:8000.

Make a change

1. Open the docs/ folder.
2. Pick a Markdown file.
3. Change the wording, add steps, or fix an error.
4. Save your changes and review the result in the browser.

Add a new page

1. Copy templates/page-template.md.
2. Save the copy inside docs/.
3. Add the page to docs/meta.json so it appears in the sidebar.
4. Refresh the preview and make sure the new page opens correctly.

Check your work

Use the script for your operating system:

• macOS: ./check-docs.command
• Windows: .\check-docs.bat
• Linux: ./check-docs.sh

If the check passes, your docs are ready to share.