AI Development Context

This document serves as a reference for AI assistants to understand the project structure, documentation processes, and conventions. It should be reviewed at the start of each session to ensure consistent and efficient development.

Project Structure

Documentation System

• Root documentation in docs/
• Project ideas in docs/ideas/
• Development guides in docs/development/
• VitePress configuration in docs/.vitepress/

VitePress Integration

• Configuration file: docs/.vitepress/config.js
• Required for:
  • Sidebar navigation
  • Footer navigation
  • Page linking
  • Site metadata

Documentation Processes

Adding New Ideas

1. File Creation

   • Create new markdown file in docs/ideas/
   • Follow naming convention: idea-name.md
   • Include required frontmatter:

     ---
     title: [Page Title]
     description: [Brief description]
     prev: [Previous page path]
     next: [Next page path]
     ---

2. Content Structure

   • Follow template from existing ideas (e.g., auction.md)
   • Include sections:
     • Overview
     • Core Features
     • Platform Ecosystem
     • Technical Requirements
     • Security Considerations
     • Future Enhancements
     • Implementation Phases
     • Success Metrics
     • Challenges to Address

3. Navigation Setup

   • Update docs/.vitepress/config.js:
     • Add new item to sidebar navigation
     • Ensure proper ordering
   • Update frontmatter in:
     • New idea file
     • Previous idea file
     • Next idea file (if exists)
   • Add link in docs/ideas.md

VitePress Requirements

1. Sidebar Navigation

   • Configure in config.js
   • Include all pages
   • Maintain logical order
   • Use consistent naming

2. Page Navigation

   • Set prev and next in frontmatter
   • Create circular navigation where appropriate
   • Update all affected files

3. File References

   • Use relative paths
   • Include .md extension in links
   • Maintain consistent casing

Best Practices

Documentation

• Follow established templates
• Maintain consistent formatting
• Use proper heading hierarchy
• Include descriptive link text
• Keep navigation structure clean

VitePress Integration

• Always check config.js for navigation
• Update all navigation-related files
• Maintain proper linking structure
• Follow VitePress conventions

File Management

• Use consistent naming
• Follow established directory structure
• Maintain proper file organization
• Update all related files

Common Tasks

Adding New Idea

1. Create idea file in docs/ideas/
2. Add content following template
3. Update ideas.md with link
4. Update config.js sidebar
5. Set up navigation links
6. Update related files' navigation

Modifying Existing Idea

1. Update content
2. Check navigation structure
3. Verify sidebar configuration
4. Update related links

Adding New Section

1. Follow existing structure
2. Update navigation if needed
3. Maintain consistent formatting
4. Update related documentation

Troubleshooting

Common Issues

1. Missing Navigation

   • Check config.js
   • Verify frontmatter
   • Update all related files

2. Broken Links

   • Verify file paths
   • Check file existence
   • Update all references

3. Inconsistent Structure

   • Follow templates
   • Check existing files
   • Maintain conventions

Session Guidelines

Initial Setup

1. Review this context document
2. Understand project structure
3. Check VitePress configuration
4. Review existing documentation
5. Read Development Context Files
   • For API-related tasks: Read development/api.md
   • For other specific contexts: Review relevant files in development/ folder
   • Always check for task-specific context before proceeding

Process Flow

1. Understand user request
2. Identify affected files
3. Plan necessary changes
4. Execute changes
5. Verify navigation
6. Update all related files

Quality Checks

1. Verify navigation structure
2. Check file references
3. Validate formatting
4. Ensure consistency
5. Update all related files

Development Context Files

Purpose

Development context files in the development/ directory provide specific guidelines and requirements for different aspects of the project. These files should be reviewed before working on related tasks.

Available Context Files

• api.md: API development guidelines, endpoints, and conventions
• Additional context files in development/ folder for specific features or components

Usage Guidelines

1. Before Starting a Task

   • Identify the relevant context file(s)
   • Review the specific guidelines
   • Understand the requirements
   • Follow the established patterns

2. For API Development

   • Always read development/api.md first
   • Follow API conventions
   • Use established patterns
   • Maintain consistency

3. For Other Features

   • Check for relevant context files
   • Review existing implementations
   • Follow project patterns
   • Maintain consistency

Context File Structure

Each context file should include:

• Purpose and scope
• Specific guidelines
• Implementation patterns
• Best practices
• Common pitfalls
• Examples

Maintaining Context

• Keep context files up to date
• Add new patterns as discovered
• Document common issues
• Include examples
• Update as needed