Getting started

Gridlines gives you a structured place to write product documentation, guides, references, and articles. The template is designed around content files, predictable folders, and reusable page patterns.

The workflow#

The daily workflow is intentionally simple: create content, place it in the right folder, order it in the sidebar, and publish it through the existing routes.

Create a section#

Create a folder for the section you want to publish. Add an index.mdx file when the section needs an overview page.

Add child pages#

Place child pages beside the overview page. Use short file names that can become stable URLs.

Order the sidebar#

Use meta.json to control section labels and page order. The sidebar should reflect how readers naturally move through the product.

What to customize first#

Start with high-impact changes that make the template feel like your product.

• Replace the example docs with your product sections.
• Update the blog examples with real editorial content.
• Adjust theme tokens, typography, and navigation labels.
• Keep the folder structure stable so links stay easy to maintain.

Good starter rule#

Keep public docs focused on what readers need to do. Keep implementation details in source comments, internal notes, or contributor documentation.