chore: lint the public docs markdown files - #145
Conversation
docs/slack-skills-plugin.md is the page rendered to docs.slack.dev and was the only authored markdown in the repo outside the rumdl include list, so a formatting regression there would have merged clean. Adds docs/**/*.md to the include list, recursive so a future docs/ subdirectory is covered too, and fixes the one pre-existing violation it surfaces: MD047, the file did not end with a newline.
mwbrooks
added
the
chore
|
| | `slack-cli` | Create, run, and manage Slack apps from the terminal with the [Slack CLI](/tools/slack-cli), and search the Slack docs from the command line. | _"Run my Slack app locally and tail the logs."_ | | ||
| | `slack-messaging` | Compose well-formatted Slack messages using standard markdown. | _"Draft a release announcement message with a bulleted list of changes."_ | | ||
| | `slack-search` | Search Slack effectively to find messages, files, channels, and people. Requires a Slack MCP Server connection. | _"Find the channel where we discuss the platform roadmap."_ | | ||
| | `test-slack-app` | Run an existing Slack app in a [developer sandbox](/tools/developer-sandboxes) and get guided, source-specific steps to confirm it works in Slack. | _"Help me check that my Slack app actually works."_ | No newline at end of file |
There was a problem hiding this comment.
note: I can't tell what changed here 🤔 But I'd guess it's the EOF newline.
mwbrooks
changed the title
zimeg
left a comment
zimeg
left a comment
There was a problem hiding this comment.
👁️🗨️ praise: Thanks for a sharp eye toward these patterns of word!
|
Thanks for the quick and positive reviews @zimeg @WilliamBergamin! 🙇🏻 |
3 participants
Summary
This pull request gives maintainers lint coverage on
docs/slack-skills-plugin.md, the page rendered to docs.slack.dev, which was the only authored markdown in the repo thatmake lintnever checked. Theincludelist already coveredskills/**/*.md,commands/*.md,README.md,AGENTS.md, and three.github/files, so a formatting regression on the published page would have merged clean.Adding
docs/**/*.mdis recursive, so a futuredocs/subdirectory is covered too. It surfaced one pre-existing violation, MD047, fixed here because the config change fails CI without it.Testing
make lintbefore: clean, 19 files. After: one MD047 indocs/slack-skills-plugin.md; fixed withrumdl check --fix, re-run clean at 20 files.make test-unit: 21 passed.Notes
Requirements
make testand the tests pass. Ranmake test-unit(21 passed); skippedmake test-eval, which needsGEMINI_API_KEYandSLACK_MCP_TOKEN.