Source: ViewEdit

Developing the Help site

This repository ships the public Help center (Astro + Starlight) and an Antora component aggregated at FTN Docs.

Prerequisites

  • Node.js (LTS)

  • pnpm

Local workflow

pnpm install
pnpm dev
pnpm build
pnpm preview

  • pnpm dev — Astro dev server (Starlight at /docs)

  • pnpm build — production build to dist/

  • pnpm preview — serve the production build locally

Repository layout

Path Purpose

src/

Astro pages, Starlight content, and assets

public/

Static files copied to the site root

docs/

Antora component (help) for docs.foodtrucknerdz.com

.github/workflows/

CI (encoding guard, Dependabot config)

Public URLs:

Allow-list .gitignore

This repo uses an allow-list .gitignore aligned with FoodTruckNerdz agent rules:

  1. * ignores everything at the repository root.

  2. !*/ allows Git to descend into directories so nested rules can apply.

  3. Explicit !/path entries whitelist tracked files and directories.

  4. Patterns such as node_modules/, dist/, and .env re-ignore generated or local files inside allowed trees.

When you add a new tracked file or directory at the repository root, add a matching ! line in .gitignore before committing. Without it, git status may not show the new path and git add can fail silently for ignored files.

Example — tracking a new root config file:

!/my-new-config.json5

Example — tracking a new top-level directory:

!/scripts/**

See changelog for when this policy was adopted.

Text encoding CI

The encoding guard workflow blocks mojibake in tracked text files. Intentional exceptions use mojibake-guard: allow on the line or entries in .encoding-allow (see dev-centr/agent-rules encoding guard docs).

Related documentation