Fix scout setup <framework> pointing at 404ing documentation links - #32
Open
quinnmil wants to merge 3 commits into
Open
Fix scout setup <framework> pointing at 404ing documentation links#32quinnmil wants to merge 3 commits into
quinnmil wants to merge 3 commits into
Conversation
3 tasks
Every open PR editing CHANGELOG.md's `## Pending` section directly meant any two concurrent PRs collided on the same lines, and each merge forced the next PR to redo the conflict resolution. Add changelog.d/, where each PR drops a new file instead of editing the shared section, so concurrent PRs can never conflict on this axis. scripts/assemble_changelog.py folds the fragments into a versioned CHANGELOG.md section at release time. See changelog.d/README.md for the fragment format and .claude/commands/release.md for the updated release process (not committed here — .claude/ isn't tracked in this repo yet). Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01BK3fzED9ksTWsvoPfsEwpS
Every framework's docs link was built as `https://scoutapm.com/docs/<framework>`, but Scout's docs are organized by language, so all 11 links 404'd. Each framework entry now carries its own verified URL. Four frameworks have no dedicated docs page, so they point at the closest working one: - rails -> /docs/ruby (the Ruby agent install guide) - phoenix -> /docs/elixir (the Elixir agent install guide) - sidekiq -> /docs/ruby#instrumented-libraries - dramatiq -> /docs/python/other-libraries#dramatiq All URLs verified at HTTP 200 with no redirect. Closes #27 Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01BK3fzED9ksTWsvoPfsEwpS
Drop changelog.d/ and the assembly script. Move this PR's changelog entry into CHANGELOG.md's Pending section directly. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01BK3fzED9ksTWsvoPfsEwpS
quinnmil
force-pushed
the
27-setup-framework-links
branch
from
September 11, 2026 17:26
1524277 to
5dd2a98
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #27
Summary
scout setup <framework>built every framework's docs link ashttps://scoutapm.com/docs/<framework>. Scout's docs are organized by language, not by framework, so all 11 links 404'd.Fix
Each framework entry now carries its own explicit, individually-verified
docsURLinstead of deriving one from the framework name./docs/ruby/docs/python/django/docs/python/flask/docs/elixir/docs/node/express/docs/php/laravel/docs/ruby/sinatra/docs/python/fastapi/docs/python/celery/docs/python/other-libraries#dramatiq/docs/ruby#instrumented-librariesFour frameworks (rails, phoenix, sidekiq, dramatiq) don't have a dedicated page — each points at the closest real page instead (the relevant language guide, or an anchor in a page that specifically covers it).
Test plan
/docs/<framework>pattern re-confirmed to 404 for all 11go test -race ./...,go vet,gofmt,golangci-lint run— cleanscout setup/scout setup <name>smoke tested for several frameworks🤖 Generated with Claude Code
https://claude.ai/code/session_01BK3fzED9ksTWsvoPfsEwpS