Documentation System
This directory contains all the documentation files for Weight Wager. The system automatically generates web pages from markdown files.
How to Add New Documentation
1. Create a Markdown File
Create a new `.md` file in this directory with your content:
```markdown
---
title: "Your Page Title"
description: "Brief description of the page"
lastUpdated: "January 1, 2025"
---
Your Content Here
Write your documentation in markdown format.
```
2. File Naming Convention
- Use lowercase with hyphens: `privacy-policy.md`, `terms-of-service.md`
- The filename (without .md) becomes the URL slug: `/docs/privacy-policy`
3. Frontmatter Options
- `title`: The page title (optional - defaults to formatted filename)
- `description`: Meta description for SEO (optional)
- `lastUpdated`: Last update date (optional)
Available Pages
- FAQ (`/docs/faq`) - Frequently Asked Questions
- Privacy Policy (`/docs/privacy-policy`) - Privacy and data protection
- Terms of Service (`/docs/terms-of-service`) - Terms and conditions
Features
- ✅ Automatic page generation from markdown files
- ✅ SEO-friendly with proper meta tags
- ✅ Responsive design that works on all devices
- ✅ Dark theme consistent with the main site
- ✅ Navigation with back buttons and breadcrumbs
- ✅ Categorized display on the main docs page
- ✅ Markdown rendering with proper styling
Navigation
The docs are accessible through:
- Main navigation: "Docs" link
- Footer links: Privacy Policy, Terms of Service
- Direct URLs: `/docs/[filename]`
Styling
The system automatically applies:
- Dark theme with gray-950 background
- Proper typography with white text
- Hover effects and transitions
- Icons based on content type
Adding New Categories
To add new document categories, update the `getDocCategory` function in `/src/app/docs/page.tsx`:
```typescript
function getDocCategory(slug: string) {
switch (slug) {
case 'faq':
return 'Support';
case 'privacy-policy':
case 'terms-of-service':
return 'Legal';
case 'your-new-doc':
return 'Your Category';
default:
return 'General';
}
}
```
Markdown Support
The system supports standard markdown including:
- Lists (bulleted and numbered)
Need Help?
If you need to add new documentation or modify existing content, simply:
1. Create or edit a `.md` file in this directory
2. The page will automatically be available at `/docs/[filename]`
3. It will appear on the main docs page at `/docs`