Skip to content

Commit 300c3a4

Browse files
committed
Switch docs to markdown-only and remove HTML pages
1 parent 664d553 commit 300c3a4

23 files changed

Lines changed: 95 additions & 784 deletions

README.MD

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -105,17 +105,15 @@ This repository includes GitHub Actions workflows:
105105

106106
## Documentation
107107

108-
- [Docs Home (Styled)](./docs/index.html)
109-
- [API Reference](./docs/pages/api.html)
110-
- [Configuration Guide](./docs/pages/configuration.html)
111-
- [Usage Examples](./docs/pages/examples.html)
112-
- [Basic Usage](./docs/pages/basic.html)
113-
- [Caching](./docs/pages/caching.html)
114-
- [Pipeline Events](./docs/pages/events.html)
115-
- [LLM Integration](./docs/pages/llm.html)
116-
- [Architecture Walkthrough](./docs/pages/walkthrough.html)
117-
118-
Markdown source docs are still available under `./docs/`.
108+
- [Docs Home](./docs/README.md)
109+
- [API Reference](./docs/api.md)
110+
- [Configuration Guide](./docs/configuration.md)
111+
- [Usage Examples](./docs/examples.md)
112+
- [Basic Usage](./docs/usage/basic.md)
113+
- [Caching](./docs/usage/caching.md)
114+
- [Pipeline Events](./docs/events.md)
115+
- [LLM Integration](./docs/integrations/llm.md)
116+
- [Architecture Walkthrough](./docs/walkthrough.md)
119117

120118
## Contributing
121119

docs/README.md

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,21 @@
1-
# Qirrel Docs Site
1+
# Qirrel Documentation
22

3-
Open `docs/index.html` for the styled docs experience with custom classes, spacing utilities, and motion.
3+
GitHub-first Markdown docs for Qirrel.
44

5-
Legacy markdown docs remain in this folder for source/reference compatibility.
5+
## Start Here
6+
7+
- [Project README](../README.MD)
8+
- [API Reference](./api.md)
9+
- [Configuration Guide](./configuration.md)
10+
- [Usage Examples](./examples.md)
11+
- [Basic Usage](./usage/basic.md)
12+
- [Caching](./usage/caching.md)
13+
- [Pipeline Events](./events.md)
14+
- [LLM Integration](./integrations/llm.md)
15+
- [Architecture Walkthrough](./walkthrough.md)
16+
17+
## Quick Navigation
18+
19+
- Core: [API](./api.md) | [Configuration](./configuration.md) | [Examples](./examples.md)
20+
- Usage: [Basic](./usage/basic.md) | [Caching](./usage/caching.md)
21+
- Advanced: [Events](./events.md) | [LLM](./integrations/llm.md) | [Architecture](./walkthrough.md)

docs/api.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# API Reference
22

3+
[Docs Home](./README.md) | [Configuration](./configuration.md) | [Examples](./examples.md) | [Basic](./usage/basic.md) | [Caching](./usage/caching.md) | [Events](./events.md) | [LLM](./integrations/llm.md) | [Architecture](./walkthrough.md)
4+
35
## Top-Level Functions
46

57
### `processText(text, configPath?)`

docs/assets/docs.css

Lines changed: 0 additions & 245 deletions
This file was deleted.

docs/assets/docs.js

Lines changed: 0 additions & 17 deletions
This file was deleted.

docs/configuration.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Configuration Guide
22

3+
[Docs Home](./README.md) | [API](./api.md) | [Examples](./examples.md) | [Basic](./usage/basic.md) | [Caching](./usage/caching.md) | [Events](./events.md) | [LLM](./integrations/llm.md) | [Architecture](./walkthrough.md)
4+
35
Qirrel loads config in this order:
46

57
1. Custom path passed to `new Pipeline(configPath)`

docs/events.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Pipeline Events
22

3+
[Docs Home](./README.md) | [API](./api.md) | [Configuration](./configuration.md) | [Examples](./examples.md) | [Basic](./usage/basic.md) | [Caching](./usage/caching.md) | [LLM](./integrations/llm.md) | [Architecture](./walkthrough.md)
4+
35
Qirrel exposes lifecycle events on `Pipeline` so you can monitor execution, collect metrics, and handle failures without modifying core processors.
46

57
## Event Names

docs/examples.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Usage Examples
22

3+
[Docs Home](./README.md) | [API](./api.md) | [Configuration](./configuration.md) | [Basic](./usage/basic.md) | [Caching](./usage/caching.md) | [Events](./events.md) | [LLM](./integrations/llm.md) | [Architecture](./walkthrough.md)
4+
35
## Single Input
46

57
```ts

0 commit comments

Comments
 (0)