Skip to content

Simplify docs#416

Merged
canercidam merged 1 commit intomainfrom
caner/simplify-docs
Apr 22, 2026
Merged

Simplify docs#416
canercidam merged 1 commit intomainfrom
caner/simplify-docs

Conversation

@canercidam
Copy link
Copy Markdown
Member

No description provided.

@canercidam canercidam merged commit 9177c25 into main Apr 22, 2026
7 checks passed
@canercidam canercidam deleted the caner/simplify-docs branch April 22, 2026 18:45
@claude
Copy link
Copy Markdown
Contributor

claude Bot commented Apr 22, 2026

Claude finished @canercidam's task in 1m 44s —— View job


Claude PR Review

  • Review PR diff
  • Check README changes
  • Check for broken links/references
  • Post review feedback

Summary

Docs cleanup PR renaming "Telemetry" → "Metrics", dropping the README "Internals" section and docs/architecture.md. Small scope, low risk — one issue worth fixing.

Findings

Broken link / stale terminologydocs/internals/writing_components.md:50

This PR renames docs/telemetry.mddocs/metrics.md but leaves behind a reference in writing_components.md:

**Note**: If a port is named `"metrics"`, it will be automatically recognized as a Prometheus endpoint and tracked by the telemetry stack. See [telemetry.md](../telemetry.md) for more information.

The link ../telemetry.md is now dead and the wording "telemetry stack" is inconsistent with the new "Metrics" naming. Inline comment posted with a [Fix this →] link.

Pre-existing nits in docs/metrics.md (not introduced by this PR, carried over from telemetry.md — not worth fixing unless you're touching the file again): leading blank line before the # Metrics H1 (line 1), and missing blank line between ## Usage and the following paragraph (line 14).
• Branch: claude/pr-416-20260422-1845

Comment thread docs/metrics.md
@@ -1,5 +1,5 @@

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Stale link not updated in this PR: docs/internals/writing_components.md:50 still references ../telemetry.md, which no longer exists after the rename. It should point to ../metrics.md, and the inline text ("telemetry stack") should also be updated to match the new naming.

**Note**: If a port is named `"metrics"`, it will be automatically recognized as a Prometheus endpoint and tracked by the telemetry stack. See [telemetry.md](../telemetry.md) for more information.

Fix this →

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