Skip to Content
⚠️Active Development Notice: TimeTiles is under active development. Information may be placeholder content or not up-to-date.
DevelopmentContributingDocumentation Guide

Documentation Guide

This guide explains how documentation works in the TimeTiles project.

Documentation Structure

All documentation lives under /apps/docs/content/ as hand-written MDX files:

  • Getting Started (/getting-started/) - Installation, quick start guides
  • Guide (/guide/) - Features, use cases, tutorials
  • Development (/development/) - Architecture, development guides, API docs
  • Self-Hosting (/self-hosting/) - Deployment, configuration, maintenance
  • Reference (/reference/) - Glossary, changelog, roadmap

API documentation is hand-written in apps/docs/content/development/api/. For implementation details beyond what the docs cover, read the source code in apps/web/app/api/.

Working with Documentation

Creating New Pages

  1. Create an .mdx file in the appropriate directory:
apps/docs/content/development/guides/my-new-guide.mdx
  1. Write your content using MDX (Markdown + JSX):
# My Guide Title
 
import { Callout } from "nextra/components";
 
<Callout type="info">Important information here</Callout>
 
## Section with code
 
\`\`\`typescript
const example = "code here"
\`\`\`
  1. Update the navigation by editing _meta.json in the same directory:
{ "existing-page": "Existing Page", "my-new-guide": "My New Guide" }

Best Practices for Manual Docs

  • Use clear, descriptive titles
  • Include practical examples
  • Add screenshots where helpful
  • Link to related documentation
  • Keep content up-to-date with code changes

Development Workflow

  1. Edit .mdx files directly in apps/docs/content/
  2. Preview with pnpm dev from the apps/docs directory
  3. Commit the documentation changes

Troubleshooting

Common Issues

  • Edit the appropriate _meta.js file in the same directory
  • Use relative paths for internal links
  • Check for typos in paths

Best Practices

  1. User-focused: Write for your audience
  2. Practical examples: Show real-world usage
  3. Visual aids: Include diagrams/screenshots where helpful
  4. Cross-reference: Link to related guides
  5. Keep concise: Avoid unnecessary verbosity

Documentation Review Checklist

  • Guides updated if behavior changed
  • Navigation (_meta.js) updated if needed
  • Links verified and working

Resources

Last updated on
ContributingTesting Guidelines