Central documentation for the Dryad programming language and its C++ implementation.
Full inventory: SITEMAP.md
Module repository. This documentation is a standalone repo (
github.com/dryadlang/docs), mapped into the source tree as thedocs/submodule. Links to../src/resolve when the module is checked out inside the source repository.
| Audience | Path |
|---|---|
| New to Dryad | Quick start |
| Writing code | Language reference → Standard library |
| Building libraries | User libraries |
| CLI & tooling | Tooling |
| Language designers | Specification (canonical PDF) |
| C++ implementors | Implementation docs |
| Visual overview | PlantUML diagrams |
docs/
├── README.md ← you are here
├── SITEMAP.md Complete file inventory
│
├── getting-started/ Install, build, contribute
│ ├── quick-start.md
│ ├── building.md
│ └── contributing.md
│
├── language/ User-facing language reference
│ ├── syntax.md
│ ├── modules.md
│ ├── execution-modes.md
│ └── diagrams.md
│
├── specification/ Canonical language specification
│ ├── README.md Spec index
│ └── theory/ PDF, LaTeX source, architecture design docs
│
├── stdlib/ @std/* API guides
│ ├── core.md, buffers.md
│ ├── collections.md, io.md
│ └── async.md, net.md
│
├── libraries/ User libraries & packages
│ ├── overview.md
│ └── packages.md
│
├── tooling/ CLI reference
│ └── cli.md
│
├── examples/ Runnable examples + benchmark manifest
│
├── diagrams/ PlantUML (core + stdlib)
│ └── dryad-language/
│
└── implementation/ Internal dev docs
├── phases/ Completion reports
├── architecture/ System design
├── plans/ Feature plans
├── principles/ SOLID, resource efficiency
└── tooling/ dryad.toml spec
dryad_theoretical_foundation_v2.pdf — formal language definition (v2.0, 34 pages)
| Area | Status | Report |
|---|---|---|
| Lexer & parser | ✅ | Phase 1 |
| Interpreter | ✅ | Phase 2 |
| Intrinsics (~50 syscalls) | ✅ | Phase 3 |
| Standard library | 🔄 | Phase 4 |
| Bytecode VM | ✅ | Phase 6 |
| AOT / LLVM | ✅ | Triple model plan |
| User libraries | ✅ | Library system |
| Module | Guide |
|---|---|
@std/core |
core.md |
@std/buffers |
buffers.md |
@std/collections |
collections.md |
@std/io |
io.md |
@std/async |
async.md |
@std/net |
net.md |
cd src
../docs/examples/run_benchmark.sh --triple # all examples × 3 modes
cd build && ctest --output-on-failure # full test suiteCatalog: examples/README.md
| Path | Role |
|---|---|
src/ |
C++ compiler, runtime, standard library, tests |
docs/ |
This module repository — documentation, examples, specification |
CHANGELOG |
Notable changes per release |
- User docs →
language/,stdlib/,libraries/ - Implementation docs →
implementation/ - Diagrams →
diagrams/dryad-language/parts/ - Update SITEMAP.md when adding new files
See CONTRIBUTING.md for the development workflow.