Skip to content

Commit 0c58640

Browse files
committed
docs: overhaul documentation site and fix plugin metadata declarations
Rebuild the docs for the new Chronicle content layout (docs/content/docs) with every fact verified against the code: - Add quickstart, architecture, scripting guide, and a write-your-first- extractor tutorial - Add per-plugin reference pages for all 35 extractors, 9 sinks, and 3 processors, replacing links out to GitHub READMEs - Rewrite examples with complete, runnable recipes - Rewrite recipe/source/sink/processor concept pages; document scope, version, variable precedence, and directory-run semantics accurately - Fix wrong facts: kafka sink sends JSON (not protobuf), docker commands missing the meteor binary name, missing kubernetes/opsgenie/pagerduty extractors, stale counts, and broken links - Remove aspirational Custom Sink and Serializer sections Code fixes surfaced by the docs audit: - Align plugins.Info entities/edges with what extractors actually emit (confluence, grafana, github, kubernetes, notion, dbt) - Fix wrong ports in postgres and couchdb sample configs (3306 -> 5432/5984) - Fix kafka sink README serialization claim - Update CLAUDE.md: agent/ renamed to runner/
1 parent 01af29a commit 0c58640

105 files changed

Lines changed: 4073 additions & 1594 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,5 +33,8 @@ meteor-plugin-*
3333
# build
3434
/dist
3535

36+
# docs (chronicle)
37+
docs/.vercel
38+
3639
.playground
3740
.claude

CLAUDE.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,10 @@ Each extractor emits **Records**. A Record contains:
1414

1515
Ownership is represented as edges with type `owned_by`. Lineage is represented as edges with type `derived_from` (entity depends on target) and `generates` (entity produces target).
1616

17-
- **Extractors**: 34+ plugins (bigquery, postgres, kafka, github, etc.)
17+
- **Extractors**: 35 plugins (bigquery, postgres, kafka, github, etc.)
1818
- **Processors**: Transform/enrich records in-flight
1919
- **Sinks**: Push to destinations (compass, kafka, file, http, etc.)
20-
- **Agent**: Orchestrates the pipeline with batching, retries, concurrency
20+
- **Runner**: Orchestrates the pipeline with batching, retries, concurrency
2121

2222
## Key Directories
2323

@@ -27,9 +27,10 @@ plugins/
2727
extractors/ Source plugins (one dir per source)
2828
processors/ Transform plugins
2929
sinks/ Destination plugins (compass, kafka, file, etc.)
30-
agent/ Pipeline orchestration
30+
runner/ Pipeline orchestration (batching, retries, concurrency)
3131
recipe/ Recipe parsing and validation
3232
cmd/ CLI commands (run, lint, list, info, gen)
33+
docs/ Documentation site (Chronicle; content in docs/content/docs/)
3334
```
3435

3536
## Data Model

docs/README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
11
# Meteor Documentation
22

3-
Built with [Chronicle](https://github.com/raystack/chronicle). Content lives in `docs/`.
3+
Built with [Chronicle](https://github.com/raystack/chronicle). Content lives in `content/docs/`.
4+
5+
To preview locally:
6+
7+
```sh
8+
cd docs
9+
npx @raystack/chronicle@0.12.5 dev
10+
```

docs/chronicle.yaml

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
1-
title: Meteor
2-
description: Plugin-driven metadata collection agent
1+
site:
2+
title: Meteor
3+
description: Plugin-driven metadata collection agent
4+
5+
content:
6+
- dir: docs
7+
label: Docs
38

49
theme:
510
name: default
@@ -12,12 +17,3 @@ navigation:
1217
search:
1318
enabled: true
1419
placeholder: Search docs...
15-
16-
llms:
17-
enabled: true
18-
19-
footer:
20-
copyright: "Raystack"
21-
links:
22-
- label: GitHub
23-
href: https://github.com/raystack/meteor

docs/concepts/overview.mdx

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

docs/concepts/processor.mdx

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

docs/concepts/recipe.mdx

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

0 commit comments

Comments
 (0)