Accessing Documentation in Development Tools

This guide explains how to access the project documentation directly from your development environment.

Via Local Development Server

When running the development server, documentation is accessible at:

http://localhost:4321/docs

This will display the documentation index page with links to all available documentation resources.

Directory Structure

All documentation is stored in the /docs directory:

/docs/
  ├── README.md                    # Documentation index
  ├── unified-markdown-system.md   # Markdown content system documentation
  ├── project-structure.md         # Project architecture guidelines
  ├── pages-structure.md           # Pages organization guidelines
  ├── nav.json                     # Navigation data for docs integration
  └── index.html                   # HTML entry point for docs

Viewing Documentation in VS Code

If you're using Visual Studio Code, you can easily preview Markdown files directly:

1. Open any Markdown file in the editor
2. Press Ctrl+Shift+V (or Cmd+Shift+V on Mac) to open a preview panel
3. Alternatively, click the "Open Preview" button in the top-right corner of the editor

Adding New Documentation

To add new documentation:

1. Create a new Markdown file in the /docs directory using kebab-case naming
2. Update the /docs/README.md index file with a link to your new document
3. Add your documentation to the nav.json file to make it available in the dev tools

Example addition to nav.json:

{
  "title": "My New Documentation",
  "path": "/docs/my-new-documentation.md"
}

Best Practices

1. Use descriptive filenames that reflect the document content
2. Maintain a consistent structure across documentation files
3. Include a clear title and introduction at the beginning of each document
4. Use appropriate Markdown formatting for headers, lists, code blocks, etc.
5. When referencing other documentation, use relative links to ensure they work in all contexts