Skip to content

Getting Started

Welcome to our documentation! This guide will help you understand how to use and contribute to this site.

You can edit documentation files directly in the /docs folder:

docs/
├── index.mdx # Homepage
├── guides/
│ └── getting-started.mdx
└── reference/
└── api-reference.mdx

All documentation files use MDX format with frontmatter:

---
title: Page Title
description: A brief description
---
Your content here...
  1. Navigate to /keystatic in your browser
  2. Log in (if authentication is enabled)
  3. Select “Guides” or “Reference” from the sidebar
  4. Click on the document you want to edit
  5. Make your changes in the visual editor
  6. Click “Save” to commit your changes

All changes made through either method are automatically tracked in Git:

  • Developers can use standard Git workflows
  • Keystatic commits changes with descriptive messages
  • Version history is maintained for all content