docs

Fractalic Documentation

This directory contains the Fractalic documentation structured for VitePress.

Purpose

Documentation for Fractalic, an advanced LLM application for generating and managing fractal-like data structures.

Structure

• index.md - Homepage with hero layout
• .vitepress/config.js - VitePress configuration
• *.md - Documentation pages organized by topic

Authoring Guidelines

This documentation follows the Fractalic documentation authoring constraints defined in .github/instructions/docs.instructions.md. Key principles:

• Plain, precise, neutral tone
• Present tense, active voice, second person
• Structured with clear headings and sections
• Consistent YAML examples using | for multi-line content
• Cross-references to related documentation

Build & Preview

For development and previewing of the documentation site:

# Install dependencies
npm install

# Start development server
npm run dev

Migration Plan

Steps and considerations for migrating from previous versions or other systems.

Open Tasks

• Review and update all links
• Ensure all images and assets are correctly referenced
• Validate YAML front matter in all markdown files

Contributing

Guidelines for contributing to the Fractalic documentation:

• Please follow the established authoring guidelines.
• Submit all changes via pull requests.
• Ensure your contributions are well-tested and do not break the build.