fix: use docs site paths for command reference See also links - #642
Open
lukegalbraithrussell wants to merge 2 commits into
Open
fix: use docs site paths for command reference See also links#642lukegalbraithrussell wants to merge 2 commits into
lukegalbraithrussell wants to merge 2 commits into
Conversation
The generated command reference "See also" links pointed to bare slugs (e.g. slack_app_delete) that do not resolve on the docs site. Emit absolute docs site paths (/tools/slack-cli/reference/commands/<name>/) matching the convention used in the hand-authored reference docs. Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #642 +/- ##
==========================================
+ Coverage 72.26% 72.36% +0.09%
==========================================
Files 238 238
Lines 20072 20072
==========================================
+ Hits 14505 14525 +20
+ Misses 4298 4277 -21
- Partials 1269 1270 +1 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
zimeg
approved these changes
Aug 19, 2026
zimeg
left a comment
zimeg
left a comment
Member
There was a problem hiding this comment.
@lukegalbraithrussell Thanks immense for catching this 🤓
Before merging it'd be great to add a few tests to prevent regressing on this logic but no blocker!
zimeg
added
bug
Add Test_commandDocsURL for the link helper and Test_genMarkdownCommand to guard that the "See also" section emits docs site paths for both the parent and child links rather than bare slugs. Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
Contributor
Author
|
@zimeg Added some unit tests! |
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
2 participants
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.
Summary
The generated command reference "See also" links pointed to bare slugs (e.g.
slack_app_delete) that do not properly resolve on the docs site, thus dead-linking.This changes
docgento emit absolute docs site paths (/tools/slack-cli/reference/commands/<name>/), matching the link convention already used in the hand-authored reference docs (e.g.docs/reference/experiments.md).Changes
commandsDocsURLPathconstant andcommandDocsURL()helper incmd/docgen/docgen.go.slack docgen ./docs/reference.🤖 Generated with Claude Code