Srcbook Documentation

Welcome to Srcbook's documentation. This documentation uses .src.md files, which are a special format that combines Markdown with executable TypeScript code cells.

Quick Navigation

• Table of Contents
• Getting Started Guide
• Features Overview
• Technical Reference

About .src.md Files

The .src.md extension is integral to Srcbook's functionality:

• It indicates that the file contains executable TypeScript code cells
• It enables Srcbook's literate programming features
• It allows for interactive documentation with live code examples

Documentation Structure

Our documentation is organized into several key sections:

• Core Documentation
  • Getting started guides
  • Feature documentation
  • Technical reference
• Advanced Topics
  • TypeScript features and configuration
  • Debugging and performance
  • System architecture
• Testing Guides
  • Test harness documentation
  • Testing strategies
• Web App Generator
  • Architecture and design
  • AI integration
  • Project structure

Getting Started

To view this documentation in its interactive form:

1. Clone the Srcbook repository
2. Follow the setup instructions in the main README
3. Open the .src.md files in your development environment

For a static view of the documentation, you can browse the files directly on GitHub or visit our GitHub Pages site.

Contributing

Interested in contributing? Check out our contributing guidelines to get started.