ignitionstack.pro v1.0 is out! Read the announcement →
Skip to Content

Contributing to Documentation

Guide for contributing to ignitionstack.pro documentation.

Documentation uses Nextra  with MDX. You can use React components inside .mdx files.

Directory Structure

documentation/
├── content/                    # All MDX content
│   ├── _meta.js               # Menu sidebar principal
│   ├── index.mdx              # Homepage
│   ├── getting-started/       # Guias iniciais
│   ├── setup/                 # Service setup
│   ├── supabase/              # Supabase documentation
│   ├── architecture/          # Arquitetura e ADRs
│   ├── components/            # Component documentation
│   ├── analytics/             # Analytics e tracking
│   ├── performance/           # Optimizations
│   ├── features/              # Features premium
│   ├── guides/                # Guides and tutorials
│   ├── deployment/            # Deploy
│   ├── testing/               # Testing
│   └── api/                   # API Reference
├── components/                 # Custom components
├── theme.config.tsx           # Theme configuration
└── public/                    # Static assets

Creating a New Page

Create the MDX file

# Example: new page under guides
touch content/guides/minha-pagina.mdx

Add frontmatter (optional)

---
title: My Page
description: SEO description
---
 
# My Page
 
Content goes here...

Update _meta.js

// content/guides/_meta.js
export default {
  index: 'Overview',
  'minha-pagina': 'My Page', // Add here
}

Available Components

Callout

import { Callout } from 'nextra/components'
 
<Callout type="info">
  Important information.
</Callout>
 
<Callout type="warning">
  Warning!
</Callout>
 
<Callout type="error">
  Critical error.
</Callout>

Steps

import { Steps } from 'nextra/components'
 
<Steps>
 
### First Step
 
Description...
 
### Second Step
 
Description...
 
</Steps>

Tabs

import { Tabs } from 'nextra/components'
 
// Dentro do seu arquivo .mdx:
<Tabs items={['npm', 'yarn', 'pnpm']}>
  <Tabs.Tab>npm install</Tabs.Tab>
  <Tabs.Tab>yarn install</Tabs.Tab>
  <Tabs.Tab>pnpm install</Tabs.Tab>
</Tabs>

Cards

import { Card, Cards } from '@/components/ui/card'
 
<Cards>
  <Card title="Title" href="/link">
    Card description.
  </Card>
</Cards>

Writing Conventions

Headings

Code Blocks

Use the appropriate syntax highlighting:

```typescript filename="src/example.ts"
const example = 'TypeScript'
```
 
```bash
npm run build
```
 
```sql
SELECT * FROM users;
```
// Internal links (use absolute paths from the root)
[Setup Guide](/setup/overview)
[Supabase Auth](/supabase/auth)
 
// External links
[Next.js Docs](https://nextjs.org/docs)

Tables

| Coluna 1 | Coluna 2 | Coluna 3 |
|----------|----------|----------|
| Valor 1  | Valor 2  | Valor 3  |

Best Practices

Clarity

Structure

Maintenance

Testing Locally

# Install dependencies
cd documentation
npm install
 
# Run the development server
npm run dev
 
# Build to smoke-test
npm run build

Open http://localhost:3001 to preview.

Review Checklist

Before submitting, verify:

Resources