@bluefly/docs v0.1.1

BFDocs - Documentation Hub

Status: ✅ 80% FUNCTIONAL - Documentation generation and management system
Reality: Solid foundation for technical documentation, some advanced features planned but not implemented

Current Status

This project provides working documentation tooling. The core functionality works reliably for generating and managing technical documentation across projects.

What Works

• Basic documentation generation from source code
• Markdown-based documentation structure
• TypeScript type extraction and documentation
• API documentation generation
• Static site generation with Vite
• Documentation templates
• Basic search functionality
• Documentation validation

In Progress

• 🚧 AI-powered documentation enhancement
• 🚧 Model registry API documentation
• 🚧 Advanced cross-project linking
• 🚧 Real-time documentation updates
• 🚧 Comprehensive API reference generation
• 🚧 Multi-format export (PDF, DOCX)

Future Enhancements

• Interactive API playground (basic version works)
• Documentation versioning system (manual versions work)
• Enhanced search capabilities (basic search functional)
• Analytics and usage tracking

Installation

# Clone the repository
git clone <repository>
cd bfdocs

# Install dependencies
npm install

# Build the project
npm run build

# Start development server
npm run dev

Usage

Generate Documentation

# Generate docs for a TypeScript project
npm run docs:generate -- --input ./src --output ./docs

# Generate API documentation
npm run docs:api -- --spec ./openapi.yaml --output ./docs/api

# Build static documentation site
npm run docs:build

# Serve documentation locally
npm run docs:serve

Documentation Structure

docs/
├── api/              # API documentation
├── guides/           # User guides
├── reference/        # Technical reference
├── examples/         # Code examples
└── migration/        # Migration guides

Features

Documentation Generation

• Automatic extraction from TypeScript/JavaScript
• JSDoc and TSDoc support
• Markdown enhancement
• Code example extraction
• Type documentation

API Documentation

• OpenAPI/Swagger support
• Interactive API explorer
• Request/response examples
• Authentication documentation
• Error code reference

Static Site Features

• Fast static site generation
• Full-text search
• Syntax highlighting
• Mobile responsive design
• Dark mode support

Configuration

Create a bfdocs.config.js file in your project root:

module.exports = {
  input: './src',
  output: './docs',
  theme: 'default',
  features: {
    search: true,
    apiPlayground: true,
    darkMode: true
  },
  plugins: [
    // Add plugins here
  ]
};

Project Structure

bfdocs/
├── src/
│   ├── core/           # Core documentation engine
│   ├── generators/     # Documentation generators
│   ├── parsers/        # Code parsers
│   ├── templates/      # Documentation templates
│   └── utils/          # Utility functions
├── scripts/            # Build and utility scripts
├── examples/           # Example projects
├── strategic/          # Strategic documentation
└── model-registry-api/ # Model registry API specs

API

Core API

import { DocumentationGenerator } from 'bfdocs';

const generator = new DocumentationGenerator({
  input: './src',
  output: './docs'
});

await generator.generate();

Plugin API

export interface BFDocsPlugin {
  name: string;
  transform?: (content: string, metadata: any) => string;
  generate?: (config: any) => Promise<void>;
}

Development

# Install dependencies
npm install

# Run tests
npm test

# Run linting
npm run lint

# Build for production
npm run build

# Watch mode for development
npm run dev

Templates

BFDocs includes several documentation templates:

• standard.md - Standard documentation template
• api.md - API documentation template
• architecture.md - Architecture documentation template
• db_schema.md - Database schema documentation

Known Issues

• Model registry API integration is incomplete
• Some TypeScript complex types may not parse correctly
• Search indexing can be slow for large projects
• PDF export needs formatting improvements

Contributing

This is an internal tool. When contributing:

1. Follow the existing code style
2. Add tests for new features
3. Update documentation
4. Submit pull requests to the development branch

Migration Notes

If migrating from an older version:

• Check the migration guides in docs/migration/
• Update configuration files to new format
• Regenerate documentation after upgrading

License

Proprietary - Internal Use Only