- Product name (short): Loki
- Product name (first mention in prose): Grafana Loki
- GitHub org/repo: https://github.com/grafana/loki
- Default development branch:
main - Release branch pattern:
release-X.Y.x - Docs version mapping:
- Documentation root (filesystem):
loki/docs/sources/ - Generated pages (do not hand-edit):
- /docs/sources/configure/_index.md -/docs/sources/reference/loki-config-reference.md
- Configuration reference index: /docs/sources/configure/_index.md
- Changelog:
CHANGELOG.mdat repo root - Architecture / "start here" page:
- Helm chart repository:
https://github.com/grafana-community/helm-charts(source of truth; a separate repo from this one, commonly a sibling checkout, e.g.../helm-charts) - Chart path in that repo:
charts/loki - Helm docs location (filesystem):
loki/docs/sources/setup/install/helm/ - Generated Helm values reference (do not hand-edit):
loki/docs/sources/setup/install/helm/reference.md(regenerated fromcharts/loki/values.yamlin the Helm chart repository above)
| Code area | Documentation area |
|---|---|
e.g. pkg/api/ |
e.g. docs/.../api/ |
e.g. internal/config/ |
e.g. docs/.../configuration/ |
Paths the agent should check when validating documentation claims against code.
| What to validate | Where to look |
|---|---|
| Query/syntax correctness | e.g. pkg/traceql/test_examples.yaml |
| Type definitions / intrinsics | e.g. pkg/traceql/ast.go |
| Configuration structs / defaults | e.g. internal/config/ or modules/ |
- Default
topicTypeor template names: - Weight / ordering rules:
- Internal link style (trailing slash, etc.):
- Query language / API naming (exact terms):
- Storage or format version naming (if any):
- Vale or linter config location (if any):
- Link or path to code-adjacent
AGENTS.mdfiles (e.g. generator, storage backend) when docs work touches those areas.
If applicable, list features that require coordinated updates across multiple doc trees.