Skip to content

docs: real READMEs for 4 examples + Home nav link - #40

Merged
patterncatalyst merged 2 commits into
mainfrom
docs/example-readmes
Oct 31, 2026
Merged

patterncatalyst merged 2 commits into
mainfrom
docs/example-readmes

Conversation

@patterncatalyst

Copy link
Copy Markdown
Owner

Two commits:

site: add Home to primary nav — explicit Home link (to /) as the first nav item, matching the other patterncatalyst sites.

docs(examples): write real READMEs for four examples — 37-use-method-60s-analysis, 38-opentelemetry-to-lgtm, 40-low-latency-fastpath, and 41-capstone-fleet were still unchanged _template boilerplate (41's title literally read # _template: hello-syscall). Each now has a real README grounded in the example's demo.sh, verify.lua, and source, with no invented commands or output:

  • loadmix — Brendan Gregg's USE method as a runnable program.
  • lsp-otel — a traced server whose OTLP export is verified by querying Tempo/Prometheus through Grafana.
  • chatterd-fastpath — the echo hot path (core pin, reused buffer, busy-poll) proven from /proc/<pid>/status.
  • the fleet final project — one binary, four subcommands, assembling pmon/chatterd/sysagent/fwatch across the two-VM lab.

Professional-voice clean (0 ban-tier); capstone kept only as the directory slug.

Explicit Home link (to site root /) as the first primary-nav item, matching the
other patterncatalyst sites.
37/38/40/41 shipped as unchanged _template boilerplate. Wrote a real README for
each, grounded in the example's demo.sh, verify.lua, and source (no invented
commands or output): loadmix (USE method), lsp-otel (OTel to LGTM),
chatterd-fastpath (low-latency hot path), and the fleet final project.
@patterncatalyst
patterncatalyst merged commit 23b065a into main Oct 31, 2026
9 checks passed
@patterncatalyst
patterncatalyst deleted the docs/example-readmes branch October 31, 2026 13:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant