Skip to content

feat: add a hide-pinned flag to docs search - #772

Merged
mwbrooks merged 2 commits into
mainfrom
mwbrooks-docs-search-hide-pinned
Nov 13, 2026
Merged

mwbrooks merged 2 commits into
mainfrom
mwbrooks-docs-search-hide-pinned

Conversation

@mwbrooks

@mwbrooks mwbrooks commented Nov 11, 2026 •

Copy link
Copy Markdown
Member

Changelog

New --hide-pinned flag on slack docs search leaves out the pages docs.slack.dev pins to the top of some searches.

Summary

This pull request adds a --hide-pinned flag to slack docs search, so coding agents that already have the Slack MCP and Skills Plugin can leave out the plugin page that docs.slack.dev is starting to pin to the top of searches about coding agents.

$ slack docs search "mcp" --category=guides --hide-pinned
  • docs.slack.dev is adding a pin to its search API (slack/docs-slack-dev#272): searches that mention Claude, Cursor, Codex, MCP, or coding agents put the plugin page first. The flag sends the API's pin=false.
  • With no flag, the pin stays. A developer or an agent that has not heard of the plugin should still find it.
  • The slack-docs skill already sends pin=false when it calls the API directly (fix: leave the docs search pin out of slack-docs searches slack-skills-plugin#215). It will pass --hide-pinned once it starts using slack docs search.

Testing

  • Run slack docs search "mcp" --category=guides --hide-pinned --output=json and confirm it returns results. The API ignores pin=false until the docs.slack.dev change deploys.
  • Run slack docs search --help and confirm the flag and its example.

Notes

  • Open question: --hide-pinned or --hide-pin? --hide-pinned names the results you see, so the CLI doesn't depend on the API's pin parameter name. --hide-pin matches that parameter. I lean toward --hide-pinned, and Codex's review agreed, but I'd like your take.
  • It applies to text and JSON output. --output=browser opens the site's search page, which has its own pin behaviour.

Requirements

@mwbrooks mwbrooks added this to the Next Release milestone Nov 11, 2026
@mwbrooks mwbrooks added enhancement M-T: A feature request for new functionality changelog Use on updates to be included in the release notes semver:minor Use on pull requests to describe the release version increment labels Nov 11, 2026
@mwbrooks mwbrooks self-assigned this Nov 11, 2026
@mwbrooks mwbrooks changed the title feat: add a hide-pinned flag to docs search feat: docs search command can now --hide-pinned search results Nov 11, 2026
@codecov

codecov Bot commented Nov 11, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 78.98%. Comparing base (024c7de) to head (4d26ec5).

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #772      +/-   ##
==========================================
+ Coverage   78.95%   78.98%   +0.02%     
==========================================
  Files         241      241              
  Lines       18365    18371       +6     
==========================================
+ Hits        14501    14511      +10     
+ Misses       3864     3860       -4     

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@mwbrooks mwbrooks changed the title feat: docs search command can now --hide-pinned search results feat: add a hide-pinned flag to docs search Nov 11, 2026
@mwbrooks
mwbrooks marked this pull request as ready for review November 11, 2026 05:16
@mwbrooks
mwbrooks requested review from a team as code owners November 11, 2026 05:16
@haleychaas

Copy link
Copy Markdown
Contributor

Is there a way to tell if the user already has the plugin? I'm thinking that we'd still want it to come in at the top of the search for users who don't have it. If not, that's ok!

@zimeg zimeg left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

📚 @mwbrooks LGTM! I'd keep --hide-pinned too, since it reads alongside the --hide-triggers flag on run and deploy and doesn't tie the CLI to the API's parameter name.

@mwbrooks

Copy link
Copy Markdown
Member Author

@haleychaas The CLI can't tell, so it keeps the pin by default. Only the slack-docs skill passes --hide-pinned, and an agent running that skill already has the plugin. Anyone without it still sees the plugin page first. 🙇

@mwbrooks

Copy link
Copy Markdown
Member Author

Thanks @zimeg for the review and @haleychaas for checking that people without the plugin still see it first! 🙇

@mwbrooks
mwbrooks merged commit 24f8d62 into main Nov 13, 2026
13 checks passed
@mwbrooks
mwbrooks deleted the mwbrooks-docs-search-hide-pinned branch November 13, 2026 04:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

changelog Use on updates to be included in the release notes enhancement M-T: A feature request for new functionality semver:minor Use on pull requests to describe the release version increment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants