Skip to content

scout setup <framework>: every framework's documentation link 404s #27

Closed

Description

@quinnmil

Problem

scout setup <framework> prints a docs URL built as https://scoutapm.com/docs/<framework> for every one of the 11 documented frameworks. That URL pattern doesn't match how Scout's docs are actually organized (by language, not by framework), so every framework's link 404s.

$ scout setup rails
...
Documentation: https://scoutapm.com/docs/rails

https://scoutapm.com/docs/rails → 404.

Verified

All of the following framework-first URLs 404:
/docs/rails, /docs/django, /docs/flask, /docs/phoenix, /docs/express, /docs/laravel, /docs/sinatra, /docs/fastapi, /docs/celery, /docs/dramatiq, /docs/sidekiq.

The language-first roots and several specific pages return 200:
/docs/ruby, /docs/python, /docs/elixir, /docs/php, /docs/node, /docs/python/django, /docs/python/flask, /docs/python/fastapi, /docs/python/celery, /docs/ruby/sinatra, /docs/php/laravel, /docs/node/express.

No working page was found under a "docs" tree for dramatiq, sidekiq, phoenix, or rails specifically — those may need a different destination entirely (blog post, GitHub setup guide, etc.) rather than a /docs/<language>/<framework> path.

Fix

cmd/setup.go builds the URL from a bare framework-name lookup table. Each entry needs its own explicit url (or language + path) field instead of a single string interpolated into /docs/%s, since the correct path per framework isn't a mechanical transform of the framework name. Worth spot-checking every resulting URL manually as part of the fix, since a couple of frameworks may not have a docs page at all and should point somewhere else or be removed from the list until they do.

Found during

A pre-1.0 audit of the whole CLI.

Activity

  1. added a commit that references this issue on Sep 10, 2026
    1524277
  2. added a commit that references this issue on Sep 11, 2026
    105ac36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions