feat: add documentation check workflow for pull requests - #20907

Task created: https://dev.coder.com/tasks/DevelopmentCats/e9855519-c8d8-4825-81fb-795633a9ed4f

📚 Documentation Check

✨ No Changes Needed

Reason: Internal CI/CD workflow - No user-facing impact

This PR adds a GitHub Actions workflow (doc-check.yaml) that is purely for internal development automation. This workflow:

• Triggers when a doc-check label is added to PRs or via manual workflow dispatch
• Creates a Coder task to analyze PRs for documentation needs
• Posts recommendations as PR comments

Since this is an internal development tool that doesn't affect Coder users, end-users, admins, or the public API/CLI, no documentation updates are needed. The workflow is self-contained in .github/workflows/ and is only used by Coder maintainers during the development process.

📚 Documentation Check

✨ No Changes Needed

Reason: Internal CI/CD tooling only - no user-facing impact

This PR adds an internal GitHub Actions workflow (doc-check.yaml) that automates documentation review for pull requests. This is internal development infrastructure that:

• Triggers on the doc-check label or manual workflow dispatch
• Uses Coder's internal task creation system to analyze PRs
• Comments on PRs with documentation recommendations

Why no docs needed:

1. Internal automation only - This workflow is for Coder maintainers, not users
2. No user-facing features - Users don't interact with this workflow
3. No API/CLI changes - No changes to Coder's product surface area
4. Development tooling - Similar to other CI workflows in .github/workflows/ that aren't documented in user docs

The existing documentation about GitHub Actions in README.md (Setup Coder action, Template action) remains accurate and complete. This new workflow is purely for internal development process improvement.

I'm a Bot

📚 Documentation Check

✨ No Changes Needed

This PR adds a GitHub Actions workflow (doc-check.yaml) for internal CI/CD automation to help contributors identify when documentation updates are needed. This is an internal development tool and does not require user-facing documentation because:

1. Internal Process: The workflow is part of the Coder team's development and CI/CD infrastructure
2. Not User-Facing: External users and contributors won't directly interact with or need to understand this automated check
3. Self-Documenting: The workflow includes clear inline comments and prompts that explain its purpose and usage
4. Optional Label: Contributors can choose to use the doc-check label to trigger this automation, but it's not a feature they need to learn or configure

The workflow enhances the existing contribution process without changing any user-visible functionality or requiring external contributors to understand its implementation details.

This comment was generated by an AI Agent through Coder Tasks

📚 Documentation Check

✨ No Changes Needed

Reason: Internal changes only - No user-facing impact

This PR adds a GitHub Actions workflow (.github/workflows/doc-check.yaml) that is purely an internal CI/CD automation tool. The workflow:

• Triggers on the doc-check label or manual dispatch
• Creates Coder tasks to analyze PRs for documentation needs
• Posts comments back to PRs with documentation recommendations

This is an internal development workflow that:

1. Not user-facing: Contributors don't need to understand or interact with this workflow directly
2. Self-documenting: The workflow itself contains clear inline comments and structured steps
3. Internal automation: Part of the repository's CI/CD infrastructure, similar to other workflows in .github/workflows/

The existing contributing documentation in docs/about/contributing/CONTRIBUTING.md already covers the general development workflow and PR process. Internal GitHub Actions workflows are typically not documented in user-facing or contributor documentation unless they require specific contributor interaction (like the pr-deploy.yaml workflow which is mentioned because it creates preview deployments).

This comment was generated by an AI Agent through Coder Tasks

📚 Documentation Check

✨ No Changes Needed

Reason: Internal automation workflow - no user-facing impact

Analysis:
This PR adds a new GitHub Actions workflow (.github/workflows/doc-check.yaml) that automates documentation review for pull requests. This is an internal development tool that:

1. Triggers on the doc-check label or manual workflow dispatch
2. Creates a Coder Task to analyze PRs for documentation needs
3. Posts automated comments with documentation recommendations

This workflow is not user-facing and does not require documentation because:

• It's an internal CI/CD automation for maintainers
• Users don't interact with or need to know about this workflow
• It's similar to other internal workflows in .github/workflows/ that are not documented
• The workflow itself analyzes and documents other changes

If this workflow were to be made available for external contributors or required special setup, documentation could be added to docs/about/contributing/CONTRIBUTING.md under a CI/CD or automation section, but that's not necessary for internal-only automation.

This comment was generated by an AI Agent through Coder Tasks

📚 Documentation Check

✨ No Changes Needed

This PR adds a new GitHub Actions workflow (.github/workflows/doc-check.yaml) that automates documentation review for pull requests. This is an internal development tool with no user-facing impact.

Reasoning:

• Internal CI/CD workflow - Not a user-facing feature that requires documentation
• Development automation - Used by maintainers to trigger automated documentation checks via the doc-check label
• No API/CLI changes - Does not modify any public interfaces, commands, or user behaviors
• Infrastructure-only - Similar to other CI workflows in .github/workflows/ which are not documented in user-facing docs

The workflow integrates with Coder Tasks to analyze PRs and suggest documentation updates, but this is a contributor/maintainer workflow, not something end users need to know about or interact with.

This comment was generated by an AI Agent through Coder Tasks

I think we should keep updating the single comment instead of making a new comment on each new commit