Skip to content

chore: lint the public docs markdown files - #145

Open
mwbrooks wants to merge 1 commit into
mainfrom
mwbrooks-rumdl-lint-docs
Open

chore: lint the public docs markdown files#145
mwbrooks wants to merge 1 commit into
mainfrom
mwbrooks-rumdl-lint-docs

Conversation

@mwbrooks

@mwbrooks mwbrooks commented Sep 3, 2026

Copy link
Copy Markdown
Member

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 that make lint never checked. The include list already covered skills/**/*.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/**/*.md is recursive, so a future docs/ subdirectory is covered too. It surfaced one pre-existing violation, MD047, fixed here because the config change fails CI without it.

Testing

  • make lint before: clean, 19 files. After: one MD047 in docs/slack-skills-plugin.md; fixed with rumdl check --fix, re-run clean at 20 files.
  • make test-unit: 21 passed.

Notes

  • The docs page change is whitespace only, so nothing renders differently on docs.slack.dev.

Requirements

  • I've read and understood the Contributing Guidelines and have done my best effort to follow them.
  • I've read and agree to the Code of Conduct.
  • I've run make test and the tests pass. Ran make test-unit (21 passed); skipped make test-eval, which needs GEMINI_API_KEY and SLACK_MCP_TOKEN.

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 mwbrooks added the chore Maintainer work: repo files, release scaffolding, general maintenance label Sep 3, 2026
@changeset-bot

changeset-bot Bot commented Sep 3, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: a158f1e

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@mwbrooks mwbrooks added the semver:patch Changes trigger a patch version bump label Sep 3, 2026
@mwbrooks mwbrooks self-assigned this Sep 3, 2026
| `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

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

note: I can't tell what changed here 🤔 But I'd guess it's the EOF newline.

@mwbrooks
mwbrooks marked this pull request as ready for review September 3, 2026 22:00
@mwbrooks
mwbrooks requested a review from a team as a code owner September 3, 2026 22:00
@mwbrooks mwbrooks changed the title chore: lint the public docs page with rumdl chore: lint the public docs markdown files Sep 3, 2026

@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.

👁️‍🗨️ praise: Thanks for a sharp eye toward these patterns of word!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

chore Maintainer work: repo files, release scaffolding, general maintenance semver:patch Changes trigger a patch version bump

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants