Skip to content

Commit 402d175

Browse files
committed
docs: fix mkdocs navigation and macro syntax errors
- Add missing flag files to navigation: buffers, enrichment, runtime, stores - Remove reference to non-existent containers.1.md flag file - Escape Go template examples in event-structure.md using raw blocks to prevent mkdocs-macros plugin from parsing them as Jinja2 templates Fixes mkdocs build warnings and macro syntax errors.
1 parent 649946c commit 402d175

2 files changed

Lines changed: 8 additions & 1 deletion

File tree

docs/docs/outputs/event-structure.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -160,6 +160,7 @@ If you're using Go templates, update your field references:
160160

161161
### Template Examples
162162

163+
{% raw %}
163164
**Before:**
164165
```go
165166
Event: {{.EventName}}
@@ -205,11 +206,13 @@ Time: {{.timestamp.seconds}}.{{.timestamp.nanos}}
205206
{{.name}}: {{.value}}
206207
{{end}}
207208
```
209+
{% endraw %}
208210

209211
### Accessing Event Data
210212

211213
Event-specific data is in the `.data` array. Each item has a `.name` and a typed `.value` field:
212214

215+
{% raw %}
213216
```go
214217
{{range .data}}
215218
{{if eq .name "pathname"}}
@@ -221,6 +224,7 @@ Event-specific data is in the `.data` array. Each item has a `.name` and a typed
221224
{{end}}
222225
{{end}}
223226
```
227+
{% endraw %}
224228

225229
## Event Value Types
226230

mkdocs.yml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,10 +37,13 @@ nav:
3737
- output: docs/flags/output.1.md
3838
- capture: docs/flags/capture.1.md
3939
- config: docs/flags/config.1.md
40-
- containers: docs/flags/containers.1.md
4140
- capabilities: docs/flags/capabilities.1.md
4241
- logging: docs/flags/logging.1.md
4342
- server: docs/flags/server.1.md
43+
- buffers: docs/flags/buffers.1.md
44+
- enrichment: docs/flags/enrichment.1.md
45+
- runtime: docs/flags/runtime.1.md
46+
- stores: docs/flags/stores.1.md
4447
- Events:
4548
- Overview: docs/events/index.md
4649
- Built-in Events:

0 commit comments

Comments
 (0)