Skip to content

Commit a31a149

Browse files
committed
docs: add runtime plugins and DSL chapters, reorganize README
- Add chapters 14 (Runtime Plugins) and 15 (Building DSLs) to book - Update wiki workflow to deploy new chapters and fix their internal links - Move Quick Start section to top of README for better discoverability - Add comprehensive Zyn Book navigation with all 15 chapters - Replace old Quick Start with Development Setup section
1 parent 536db8f commit a31a149

2 files changed

Lines changed: 50 additions & 4 deletions

File tree

.github/workflows/wiki.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,8 @@ jobs:
3737
cp book/11-hir-builder.md wiki/11-HIR-Builder.md
3838
cp book/12-embedding-sdk.md wiki/12-Embedding-SDK.md
3939
cp book/13-async-runtime.md wiki/13-Async-Runtime.md
40+
cp book/14-runtime-plugins.md wiki/14-Runtime-Plugins.md
41+
cp book/15-building-dsls.md wiki/15-Building-DSLs.md
4042
4143
# Fix internal links for wiki format
4244
sed -i 's|\./01-introduction\.md|01-Introduction|g' wiki/*.md
@@ -52,6 +54,8 @@ jobs:
5254
sed -i 's|\./11-hir-builder\.md|11-HIR-Builder|g' wiki/*.md
5355
sed -i 's|\./12-embedding-sdk\.md|12-Embedding-SDK|g' wiki/*.md
5456
sed -i 's|\./13-async-runtime\.md|13-Async-Runtime|g' wiki/*.md
57+
sed -i 's|\./14-runtime-plugins\.md|14-Runtime-Plugins|g' wiki/*.md
58+
sed -i 's|\./15-building-dsls\.md|15-Building-DSLs|g' wiki/*.md
5559
5660
- name: Upload wiki
5761
uses: Andrew-Chen-Wang/github-wiki-action@v4

README.md

Lines changed: 46 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,26 @@
1010

1111
---
1212

13+
## Quick Start
14+
15+
New to Zyntax? **Read [The Zyn Book](https://github.com/darmie/zyntax/wiki)** - a comprehensive guide covering everything from basic grammar syntax to building complete DSLs with runtime plugins.
16+
17+
```bash
18+
# Build zyntax
19+
cargo build --release
20+
21+
# Compile and run a Zig file using the zig.zyn grammar
22+
./target/release/zyntax compile \
23+
--grammar crates/zyn_peg/grammars/zig.zyn \
24+
--source examples/hello.zig \
25+
--run
26+
27+
# Start an interactive REPL
28+
./target/release/zyntax repl --grammar crates/zyn_peg/grammars/zig.zyn
29+
```
30+
31+
---
32+
1333
## 🎯 What is Zyntax?
1434

1535
**Zyntax is a complete compiler infrastructure and runtime framework** designed for building high-performance, memory-safe programming languages. It provides:
@@ -403,22 +423,22 @@ See [Embedding SDK Documentation](./book/12-embedding-sdk.md) for complete guide
403423

404424
---
405425

406-
## 🚀 Quick Start
426+
## 🚀 Development Setup
407427

408428
```bash
409429
# Clone the repository
410430
git clone https://github.com/darmie/zyntax.git
411431
cd zyntax
412432

433+
# Build the compiler
434+
cargo build --release
435+
413436
# Run tests
414437
cargo test
415438

416439
# Run comprehensive end-to-end tests
417440
cargo test --test end_to_end_comprehensive
418441
cargo test --test end_to_end_simple
419-
420-
# Build the compiler
421-
cargo build --release
422442
```
423443

424444
---
@@ -536,6 +556,28 @@ cargo build --release
536556

537557
## 📚 Documentation
538558

559+
### The Zyn Book
560+
561+
**[The Zyn Book](https://github.com/darmie/zyntax/wiki)** is the comprehensive guide to Zyntax:
562+
563+
1. [Introduction](https://github.com/darmie/zyntax/wiki/01-Introduction) - What is Zyn and why use it?
564+
2. [Getting Started](https://github.com/darmie/zyntax/wiki/02-Getting-Started) - Your first Zyn grammar
565+
3. [Using the CLI](https://github.com/darmie/zyntax/wiki/03-Using-the-CLI) - Compilation, execution, and REPL
566+
4. [Grammar Syntax](https://github.com/darmie/zyntax/wiki/04-Grammar-Syntax) - PEG-based grammar rules
567+
5. [Semantic Actions](https://github.com/darmie/zyntax/wiki/05-Semantic-Actions) - JSON command blocks
568+
6. [The TypedAST](https://github.com/darmie/zyntax/wiki/06-The-TypedAST) - Understanding the target representation
569+
7. [TypedAST Builder](https://github.com/darmie/zyntax/wiki/07-TypedAST-Builder) - Building AST nodes programmatically
570+
8. [Complete Example: Zig](https://github.com/darmie/zyntax/wiki/08-Zig-Example) - A real-world grammar walkthrough
571+
9. [Reference](https://github.com/darmie/zyntax/wiki/09-Reference) - Command reference and API
572+
10. [Packaging & Distribution](https://github.com/darmie/zyntax/wiki/10-Packaging-Distribution) - ZPack format, AOT linking
573+
11. [HIR Builder](https://github.com/darmie/zyntax/wiki/11-HIR-Builder) - Building HIR directly for custom backends
574+
12. [Embedding SDK](https://github.com/darmie/zyntax/wiki/12-Embedding-SDK) - Embedding Zyntax in Rust applications
575+
13. [Async Runtime](https://github.com/darmie/zyntax/wiki/13-Async-Runtime) - Promise-based async native runtime
576+
14. [Runtime Plugins](https://github.com/darmie/zyntax/wiki/14-Runtime-Plugins) - ZRTL standard library plugins
577+
15. [Building DSLs](https://github.com/darmie/zyntax/wiki/15-Building-DSLs) - Creating domain-specific languages
578+
579+
### Technical Documentation
580+
539581
- **[Architecture Guide](docs/ARCHITECTURE.md)** - Complete system architecture
540582
- **[HIR Builder Example](docs/HIR_BUILDER_EXAMPLE.md)** - How to construct HIR programmatically
541583
- **[Async Runtime Design](docs/ASYNC_RUNTIME_DESIGN.md)** - Async/await internals

0 commit comments

Comments
 (0)