# ISA DSL Documentation

Welcome to the ISA DSL documentation. This directory contains all documentation for the project.

## Documentation Files

- **[INDEX.md](INDEX.md)**: Documentation index and navigation guide
- **[DSL_Specification.md](DSL_Specification.md)**: Complete DSL specification covering all features
- **[EXAMPLES.md](EXAMPLES.md)**: Detailed documentation of example ISA specifications
- **[TESTING.md](TESTING.md)**: Complete testing documentation and test suite overview (111 tests, all passing)

## Generated Tools Documentation

- **[Simulator.md](Simulator.md)**: Documentation for the generated instruction simulator
- **[Assembler.md](Assembler.md)**: Documentation for the generated assembler
- **[Disassembler.md](Disassembler.md)**: Documentation for the generated disassembler
- **[documentation_generation.md](documentation_generation.md)**: Documentation generator features and usage

## Quick Start

1. New to the project? Start with the [main README](../README.md)
2. Learning the DSL? Read the [DSL Specification](DSL_Specification.md)
3. Need examples? Check [Examples Guide](EXAMPLES.md)
4. Running tests? See [Testing Documentation](TESTING.md)

## Project Status

**Current Status**: ✅ Ready for Deployment (Beta)

- **Test Suite**: 
  - 111 Python tests, all passing, 0 skipped, 0 failed
  - 18 VS Code extension tests, all passing
- **Code Quality**: Modular, well-organized, follows best practices
- **Documentation**: Complete and up-to-date
- **Dependencies**: All properly specified in pyproject.toml
- **CI/CD**: Automated testing on GitHub Actions for both Python and VS Code extension

## Documentation Structure

All documentation is organized in this `docs/` folder for easy navigation and maintenance. No markdown files exist in the project root except `README.md`.
