Commit Graph
2 Commits
Author SHA1 Message Date
DottaandClaude Opus 5.5 171e70c11d refactor: drop span and run-log event catalogs from the observability docs (#21779)
## Thinking Path

> - Paperclip is the open source app people use to manage AI agents for
work
> - `doc/observability.md` and `doc/run-log-events.md` described every
OpenTelemetry span and every run-log event
> - `rules/data-paths.mdc` told authors to update
`doc/run-log-events.md` for each event, so both files only grew: 2,313
and 1,263 lines
> - Each span and event is already defined next to the code that writes
it, and its name is a literal string that a search finds in one step
> - This pull request removes the per-span and per-event catalogs and
keeps only what code does not say
> - The benefit is two short docs that do not drift from the code, and
no rule that makes them grow again

## Linked Issues or Issue Description

Refs #21670, #21700, and #21743 (the same cleanup for other docs).

**Issue type**

Outdated or confusing documentation.

**Where is the issue?**

`doc/observability.md`, `doc/run-log-events.md`, and
`rules/data-paths.mdc`

**What's wrong?**

The two docs repeated span names, span attributes, and event payloads
that the code defines. Operator setup started at line 138 of
`doc/observability.md`. The rule required a doc edit for every new
run-log event.

**Suggested fix**

Keep operator setup and the Sentry privacy contract. Point to the code
for span and event definitions. Remove the rule line that requires a doc
entry per event.

## What Changed

- `doc/observability.md` is now 619 lines. It keeps: how to enable
tracing, `service.version` resolution, scope, how to enable Sentry, DSN
delivery, environment attribution, privacy settings, server request
data, the core of "Run failure context", browser data, fail-open
behavior, the default capture set, and operator responsibilities. Kept
text is unchanged except the intro and two sentences noted below.
- Deleted from `doc/observability.md`: budget, Slack receipt, task
detail, and browser tracing notes; controller preparation phases; native
Runner spans; sandbox startup spans; sandbox duplex transport; shared
skill preparation; invocation attribution; and about 500 lines of
per-failure detail in "Run failure context".
- Replaced that per-failure detail with one paragraph. It names the
failures that `unexpected` mode keeps out of Sentry, and says the
remaining diagnostic contexts are defined in `server/src/sentry.ts`.
"Default capture set" now says the same.
- `doc/run-log-events.md` is now 23 lines. It says what the run log is,
where events are defined and appended, and keeps the payload storage
note.
- `rules/data-paths.mdc`: the run-log line now says to define an event
where it is written, not in a doc. The span-allowlist line now says the
allowlist is in the code that opens the span. The review levels and
globs do not change.
- Repointed links in two feature maps, two agent-access map files,
`tests/runner-e2e/SUITES.md`, `doc/runner-api-tools.md`, and the
Telemetry README. Updated the `honeycomb-tracing` skill and one code
comment in `packages/adapter-utils/src/http2-bridge-server.ts`.

## Verification

- A script built the new `doc/observability.md` from line ranges of the
old file and asserts the first line of each range.
- A link check on all changed Markdown files found 0 missing files and 0
missing anchors. The remaining inbound anchors (`#enabling-tracing`,
`#sentry-error-monitoring`) still exist.
- No test reads either doc.
- `node scripts/check-maps.mjs` passes.
- `node --test .github/scripts/tests/*.test.mjs`: 808 pass, 0 fail.
- `pnpm verify` was not run. This worktree has no installed
dependencies. The only code change is a comment.

## Risks

- The privacy contract no longer lists each run-failure diagnostic
context field. `server/src/sentry.ts` is now the list. A reviewer of a
Sentry change must read that file.
- No browsable list of span names or run-log event names remains. A
search for the quoted name finds the producer.
- `.greptile/files.json` still scopes `rules/data-paths.mdc` to both
docs. Both files still exist, so it does not change.

## Model Used

- Claude Opus 5.5 (`claude-opus-5-5`), Claude Code desktop, with tool
use. Earlier analysis in this session used Claude Fable 5.2.

## 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
- [ ] 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
- [ ] All Paperclip CI gates are green
- [ ] Greptile is 5/5 with no open P2s, recommendations, or follow-ups
- [x] I will address all Greptile and reviewer comments before
requesting merge

🤖 Generated with [Claude Code](https://claude.com/claude-code)

---------

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-15 10:06:05 -06:00
DottaandClaude b004519fde docs(agents): shorten AGENTS.md and move data-path detail to a scoped rule (#20557)
## Thinking Path

> - Paperclip is the open source app people use to manage AI agents for
work
> - `AGENTS.md` is the instruction file that each human and AI
contributor reads before a change
> - The file had 311 lines, and most of the text applied to only a few
areas of the repository
> - The file told each contributor to read five documents before every
change and to treat `doc/SPEC-implementation.md` as the build contract
> - The file listed 4 of the 12 rules in `rules/`, so the list was
already out of date
> - This pull request states contributor ownership, makes the code and
tests the source of truth, and moves path-specific detail into a scoped
rule
> - The benefit is a shorter file that agents load on every session,
with detail that loads only for the files it applies to

## Linked Issues or Issue Description

**Issue type**

Outdated or unclear contributor documentation.

**Where is the issue?**

`AGENTS.md` at the repository root.

**What's wrong?**

- The file told contributors to read five documents in order before each
change.
- The file made `doc/SPEC-implementation.md` the build contract and part
of the definition of done. The maintainer considers that document
outdated.
- The file kept a manual list of scoped rules. The list named 4 of the
12 rules.
- Rule 7 (the three data paths) used about 40 lines. The rule applies
only to telemetry, observability, and run-log files.
- The agent preflight instruction was in the verification section, not
in the setup section.
- The design system section had no number and came after the definition
of done.

**Suggested fix**

Keep in `AGENTS.md` only the text that applies to every change. Move
path-specific text to `rules/` and point to `doc/` for detail.

## What Changed

- Added an ownership statement at the top of `AGENTS.md`.
- Section 1 now says that the code and tests are the source of truth.
The spec documents are background.
- Removed the spec from the definition of done and from rule 4.
- Section 2 is now a table that maps a type of change to the document to
read.
- Removed the manual rule list. The instruction to read each matching
rule in `rules/*.mdc` stays.
- Moved agent preflight to section 4. The database reset step now says
that it deletes local data.
- Rule 7 is now a short summary. The full text is in the new
`rules/data-paths.mdc`.
- Added `rules/data-paths.mdc` to `.greptile/files.json` with the same
scope as the rule globs.
- `CONTRIBUTING.md` now links to the new rule.
- Section 7 is now the default command and six labelled rules. Maps and
Storybook are one subsection.
- The design system text is now a subsection of section 9.
- Section numbers did not change, because code comments cite `AGENTS.md
§5.7` and `§6`.

## Verification

- Open `AGENTS.md` and confirm that each link and each path resolves. A
local script checked this.
- Compare `rules/data-paths.mdc` with the old rule 7 text. The
definitions and review levels are the same.
- Confirm that `.greptile/files.json` is valid JSON and that the new
scope matches the rule globs.
- No source code changed. No test suite ran locally.

## Risks

- Contributors no longer treat the spec as a requirement. A change can
now differ from the spec without an update to the spec.
- An agent that does not read scoped rules gets only the summary of the
three data paths. The summary keeps the review level for each path.
- Two Storybook instructions now live only in `maps/README.md` and
`maps/storybook-map/README.md`.

## Model Used

- Claude (Anthropic), in Claude Code with tool use.
- `claude-opus-5-5` added the ownership line and did the first review.
- `claude-fable-5-2` wrote the restructure and this pull request.

## 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
- [ ] I have run tests locally and they pass
- [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
- [ ] All Paperclip CI gates are green
- [ ] Greptile is 5/5 with no open P2s, recommendations, or follow-ups
- [x] I will address all Greptile and reviewer comments before
requesting merge

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-authored-by: Claude <noreply@anthropic.com>
2026-11-10 09:19:10 -06:00