Documentation Content#
This directory contains all the markdown documentation files for the CV Generator project.
How It Works#
All .md and .mdx files in this directory are automatically discovered and made available in the documentation site. The file name (without the .md or .mdx extension) becomes the URL slug.
Adding New Documentation#
- Create a new
.mdor.mdxfile in the content directory - The file will automatically be picked up by the docs site
- Add a navigation entry in
apps/docs/src/config/navigation.config.tsto make it appear in the sidebar
File Naming#
- Use kebab-case for file names (e.g.,
docker-strategy.md) - The file name becomes the URL slug (e.g.,
/docs/docker-strategy) - Avoid special characters and spaces in file names
Auto-Discovery#
The docs site uses Vite's import.meta.glob to automatically discover all markdown files in this directory. No manual imports or configuration needed!