Adding & updating docs

There are two ways content gets onto this site. Pick the one that matches where the content lives.

A. You own a product/team and want your own section

Author in your own repo, not here.

1. Add a flat public-docs/ folder to your repo with Starlight-flavoured markdown (.md/.mdx). Put a page’s images in a sibling folder named after the page.

2. Keep it public-safe (T1): no credentials, no real customer data. Use fake values in every example.

3. Control reading order with sidebar: { order: N } frontmatter on each page (overview = 1, install = 2, …).

4. Ask an ilc-docs maintainer to add your repo to docs-sources.yml:

   sources:
     - name: your-section       # folder + join key (kebab-case)
       label: "Your Section"    # sidebar heading
       order: 30                # where it sits in the sidebar
       git: https://git.ilcdev.com/ilc/your-repo.git
       ref: main                # tag or branch to pull
       path: public-docs

Once listed, your public-docs/ is pulled in on every build. To publish an update, push to the ref named in the manifest (or bump the ref to a new tag).

B. You want to edit a native page here

Native pages are anything under src/content/docs/ except _sources/ (which is build-time-only and never hand-edited).

• Routine edits: commit directly to main.
• Structural changes (moving sections, reworking the tree): open a merge request — it’s public output.

Rules of the road

• _sources/ is off-limits for hand edits. It’s wiped and refilled from the source repos on every build; anything you type there is lost.
• One home per subject. If a topic belongs to a product, document it in that product’s repo, not as a native page here.
• No secrets, ever. A gitleaks scan runs in the build; keep it clean at the source.