Devlog Documentation

This directory contains comprehensive documentation for Devlog.

Documentation Structure

• index.md - Main landing page with overview and quick links
• getting-started.md - Installation and first steps
• features.md - Complete feature documentation
• usage-guide.md - Practical examples and use cases
• best-practices.md - Recommendations and tips
• troubleshooting.md - Common issues and solutions

Viewing Documentation

Online

The documentation is automatically deployed to:

• GitLab Pages: https://aice.gitlab.io/devlog/

Locally

You can view the documentation locally using mdBook:

# Install mdBook
cargo install mdbook

# Serve locally with hot reload
mdbook serve

# Or build static site
mdbook build

Contributing to Documentation

When adding or updating documentation:

1. Follow the existing structure and format
2. Use relative links between documents
3. Keep examples practical and tested
4. Ensure cross-links work correctly

Deployment

GitLab Pages

Documentation is automatically deployed via GitLab CI when changes are pushed to the main branch:

• Job: pages in .gitlab-ci.yml
• Trigger: Push to main branch with docs changes
• Tool: mdBook (Rust-native documentation generator)
• URL: https://aice.gitlab.io/devlog/

License

Documentation is licensed under MIT License, same as the project.