Skip to content

0.4.1 - Comprehensive Documentation Overhaul

This release represents a major expansion of ArcAide’s documentation ecosystem, transitioning from standalone markdown files to a fully integrated Starlight documentation site with comprehensive coverage of both user and developer needs.

  • Starlight Integration: Added @astrojs/starlight and starlight-auto-sidebar for enhanced documentation experience
  • Integrated Documentation: Moved all documentation into the main website source code
  • Auto-generated Sidebars: Automatic navigation generation for better organization
  • Search Integration: Full-text search across all documentation
  • Developer Overview - Project structure and coding standards
  • Code Style Guidelines: Comprehensive coding conventions and best practices
  • Development Commands: Full command reference for development workflow
  • Testing Guidelines: Quality assurance and testing patterns
  • Arc Framework Explanation: Detailed breakdown of the six-part storytelling structure
  • Campaign Management: Complete guide to organizing D&D campaigns
  • Entity Management: NPCs, locations, items, and custom categories
  • View/Edit Modes: Understanding the dual-interface system
  • Internal Linking: Wiki-style content cross-referencing
  • Search and Discovery: Finding and connecting campaign content
  • Best Practices: Tips for effective campaign organization
  • Hierarchical Organization: Logical grouping of user guides, developer docs, and change logs
  • Auto-generated Sidebars: Automatic navigation based on file structure
  • Cross-references: Internal linking between related documentation sections
  • Search Integration: Find any documentation content instantly
  • Code Examples: Comprehensive examples for all API endpoints and patterns
  • Visual Aids: Diagrams, file structures, and layout examples
  • Best Practices: Proven patterns and conventions throughout
  • Troubleshooting: Common issues and solutions
// Added Starlight integration
starlight({
plugins: [starlightAutoSidebar()],
title: 'Arc Aide Docs',
sidebar: [
{
label: 'User Guide',
autogenerate: {
directory: 'documentation/user-guide',
},
},
{
label: 'Developer Documentation',
collapsed: true,
autogenerate: {
directory: 'documentation/developers',
},
},
{
label: 'Change Logs',
collapsed: true,
autogenerate: {
directory: 'documentation/change-log',
},
},
],
})
src/content/docs/documentation/
├── index.md # Documentation hub
├── user-guide/ # User-facing guides
│ ├── getting-started.md # Introduction and basics
│ └── advanced-features.md # Power user features
├── developers/ # Developer documentation
│ ├── overview.md # Development guide
│ ├── architecture/ # System architecture
│ │ ├── overview.md
│ │ ├── technology-stack.md
│ │ ├── database-design.md
│ │ ├── domain-models.md
│ │ ├── component-architecture.md
│ │ ├── state-management.md
│ │ ├── security-model.md
│ │ ├── performance.md
│ │ ├── development-patterns.md
│ │ ├── theme-system.md
│ │ └── file-organization.md
│ └── api-reference/ # API documentation
│ ├── overview.md
│ ├── authentication.md
│ ├── campaigns.md
│ ├── arcs.md
│ ├── things.md
│ ├── search.md
│ └── error-handling.md
└── change-log/ # Version history
└── [existing change logs]
  • New Documentation Structure: All docs are now in src/content/docs/documentation/
  • Starlight Integration: Documentation is accessible at /documentation/ route
  • API Reference: Complete API documentation now available for integration work
  • Architecture Guides: Comprehensive system documentation for new contributors
  • Enhanced User Guides: More detailed explanations of features and workflows
  • Better Navigation: Improved organization and search capabilities
  • Visual Examples: More examples and visual aids for understanding features
  • Centralized Documentation: All documentation in one place, versioned with code
  • Better Maintenance: Documentation updates alongside feature development
  • Improved Onboarding: Comprehensive guides for both users and developers
  • Professional Presentation: Starlight provides modern, searchable documentation
  • Complete Architecture Reference: Understanding system design and patterns
  • API Documentation: Comprehensive endpoint reference for integration
  • Development Guidelines: Clear coding standards and best practices
  • Pattern Library: Reusable patterns and components
  • Comprehensive Guides: From basic usage to advanced features
  • Visual Learning: Examples and screenshots for better understanding
  • Quick Reference: Easy-to-find answers to common questions
  • Best Practices: Proven strategies for campaign management
  • Interactive Examples: Live API examples and playground
  • Video Tutorials: Visual guides for complex features
  • Community Contributions: Documentation contribution guidelines
  • Localization: Multi-language documentation support

This documentation overhaul provides a solid foundation for both current users and future contributors, ensuring ArcAide remains accessible and well-documented as it continues to evolve.