Files
DottaandPaperclip ad9f5edd49 docs: teach readable trace waterfall design (#16798)
## Thinking Path

> - Paperclip is the open source app people use to manage AI agents for
work.
> - Operators use traces to find slow work and explain task execution.
> - The Honeycomb skill explains how to find traces and add spans.
> - It gives little guidance on how a trace should read when its
branches collapse.
> - This pull request adds semantic grouping and lifecycle ownership
guidance.
> - The benefit is a clear overview that preserves useful detail for
diagnosis.

## Linked Issues or Issue Description

Related work: Refs #16453, which added this skill. Refs #16419, which
added execution preparation and response spans.

**Issue type**
Missing documentation.

**Where is the issue?**
The Honeycomb tracing skill under `.agents/skills/honeycomb-tracing/`.

**What's wrong?**
A trace can contain accurate timings but remain hard to read when most
spans share one parent. Local tests can also miss incorrect parentage in
exported traces, especially on failure.

**Suggested fix**
Explain how to group operations by purpose, preserve real parent
contexts, and inspect both collapsed and expanded exported traces. Keep
the current Observability contract as the source for exact span names
and root boundaries.

## What Changed

- Add trace design to the skill description and task routing.
- Define readable phases, meaningful folds, and real parent contexts.
- Add a reference with staging examples, failure and concurrency
pitfalls, and checks for exported traces.
- Preserve useful measurements and documented links between separate
lifecycles.
- Update the skill's display description.

## Verification

- Passed the skill creator's `quick_validate.py` check.
- Checked local Markdown references and skill metadata.
- Passed `git diff --check` after rebase onto current master.
- All 55 current-head GitHub checks passed. This includes application
build, TypeScript and Rust checks, general and serialized tests, runner
checks, browser E2E shards, and canary packaging.
- Greptile scored commit `714560594b69fb08afe7eb9fff42afef4a38e49a` at
5/5. It found no actionable issues. There are no unresolved review
threads.
- Local skill validation, reference checks, metadata checks, and
whitespace checks passed. The full local application checks did not
finish: the cold native runner build was stopped after the full CI suite
passed. Full application verification was completed in CI.

## Risks

Low risk. This change updates skill instructions only. An agent could
apply an example tree too rigidly. The reference states that examples do
not replace the current Observability contract. It preserves documented
linked roots and scope limits for verification.

## Model Used

OpenAI `gpt-6.1-sol`, with `xhigh` reasoning. Codex used local tools to
inspect session evidence, edit Markdown and YAML, and run validation.
The host does not expose the context window size.

## Checklist

- [x] I have included a thinking path that traces from project context
to this change
- [x] I have specified the model used (with version and capability
details)
- [x] I have checked ROADMAP.md and confirmed this PR does not duplicate
planned core work
- [x] I have searched GitHub for duplicate or related PRs and linked
them above
- [x] I have either (a) linked existing issues with `Fixes: #` / `Closes
#` / `Refs #` OR (b) described the issue in-PR following the relevant
issue template
- [x] I have not referenced internal/instance-local Paperclip issues or
links (only public GitHub `#NNN` / `github.com/paperclipai/paperclip`
URLs)
- [x] My branch name describes the change (e.g. `docs/...`, `fix/...`)
and contains no internal Paperclip ticket id or instance-derived details
- [x] I have run tests locally and they pass (skill validation,
references, and metadata; application checks passed in CI)
- [x] I have added or updated tests where applicable
- [x] I have updated relevant documentation to reflect my changes
- [x] I have considered and documented any risks above
- [x] All Paperclip CI gates are green
- [x] Greptile is 5/5 with no open P2s, recommendations, or follow-ups
- [x] I will address all Greptile and reviewer comments before
requesting merge

Co-authored-by: Paperclip <[email protected]>
2026-10-18 21:37:40 -05:00
..