How to contribute

Every page on this site is a Markdown file under src/content/docs/. You do not need to run anything locally to make a change.

1. Open the page you want to change.
2. Click Edit page at the bottom.
3. Make the change, then choose Create a new branch and start a pull request.
4. A bot comments the preview URL on your PR — check your change there.
5. Ask for a review. Once merged, it is live on help.licenseware.io.

Create a file such as src/content/docs/playbooks/my-topic.md. Every page needs frontmatter:

---
title: My topic
description: One sentence, used for search results and link previews.
---

Your content here.

Pages under playbooks/ and guides/ appear in the sidebar automatically, in alphabetical order. To control the order, add sidebar.order to the frontmatter:

sidebar:
  order: 2

Two things will fail CI, so it is worth knowing up front:

• description is required. It is what Google shows under your page title and what the social preview card says. Aim for 50-160 characters.
• Titles must stay under 70 characters (60 is the comfortable target) — search results truncate past that.

Run bun run seo:lint to check both before you push.

If a page is genuinely a list of questions and answers, add them to the frontmatter as well, and they become eligible for FAQ rich results in search:

faq:
  - question: Why did the collector stop sending data?
    answer: Usually the service is stopped, ingest is disabled, or an outbound proxy changed.

Only add faq: entries that really appear on the page — search engines treat structured data that does not match visible content as a violation.

bun install
bun start

The dev server hot-reloads on save at http://localhost:4321.