Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

feat(docs): add Vale style checking and docs workflow improvements#17370

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Closed
EdwardAngert wants to merge10 commits intomainfromadd-vale-linting

Conversation

EdwardAngert
Copy link
Contributor

@EdwardAngertEdwardAngert commentedApr 11, 2025
edited
Loading

relies on

Summary

  • Add Vale style checking for technical documentation
  • Create unified docs workflows and actions in .github/docs
  • Improve preview links and automated checks for documentation changes

Test plan

  1. Check that new Vale styles correctly detect common documentation errors
  2. Verify docs preview links are generated correctly in PR comments
  3. Ensure documentation actions run consistently for Markdown files

🤖 Generated withClaude Code

EdwardAngertand others added10 commitsApril 9, 2025 18:26
Creates a simplified docs preview action that comments on PRs with Vercel preview links.The action shows changed files and highlights newly added documentation from manifest.json.🤖 Generated with [Claude Code](https://claude.ai/code)Co-Authored-By: Claude <noreply@anthropic.com>
…o use the same SHA and version (v45.0.7) that the docs-ci.yaml workflow uses.\n\n\ud83e\udd16 Generated with [Claude Code](https://claude.ai/code)\n\nCo-Authored-By: Claude <noreply@anthropic.com>\
…d to match patterns from the successful pr-deploy.yaml workflow:\n- Added job-level pull-requests write permission\n- Added explicit env var for PR_NUMBER\n- Added explicit GITHUB_TOKEN environment variable\n- Added reactions-edit-mode for consistency\n\n\ud83e\udd16 Generated with [Claude Code](https://claude.ai/code)\n\nCo-Authored-By: Claude <noreply@anthropic.com>\
Create a unified composite action for docs-related workflows:- Handles file change detection with tj-actions/changed-files- Provides linting and formatting for markdown files- Generates preview links for documentation changes- Creates or updates PR comments with preview links- Includes special handling for manifest.json changes- Implements security best practices- Provides example workflow
- Add Vale style checking for documentation- Move all docs-related GitHub actions & config to centralized .github/docs directory- Consolidate docs validation in unified workflow- Update all workflows to reference new paths- Add customizable docs terminology rules
…style- Add readability checks with appropriate thresholds- Allow informal terms like 'K8s', 'dev container', 'AWS EC2' common in docs- Add technical terminology exceptions to heading case rules- Balance formal style with pragmatic documentation practices
@github-actionsGitHub Actions
Copy link

📚 Docs Preview

Your documentation changes are available for preview at:
🔗Documentation Preview

Changed Documentation Files


🤖 This comment is automatically generated and updated when documentation changes.

github-actions[bot] reacted with eyes emoji

@EdwardAngertEdwardAngert added the docs/sitedocs site-related issue/task/feature request labelApr 11, 2025
@github-actionsgithub-actionsbot added the staleThis issue is like stale bread. labelApr 19, 2025
@EdwardAngertEdwardAngert removed the staleThis issue is like stale bread. labelApr 21, 2025
EdwardAngert added a commit that referenced this pull requestApr 23, 2025
Combines features from PRs#17317,#17322, and#17370:- Adds Vale style checking for documentation- Creates a reusable workflow for documentation validation- Optimizes PR checks and post-merge validation- Adds automatic GitHub issue creation for broken links- Updates all documentation checks to run in a structured mannerThis PR supersedes:- PR#17317: Docs Preview GitHub Action- PR#17322: Shared Docs GitHub Action- PR#17370: Vale Style Checking and Docs Workflow Improvements
@EdwardAngert
Copy link
ContributorAuthor

replaced by#17522

@github-actionsgithub-actionsbot locked and limited conversation to collaboratorsApr 23, 2025
Sign up for freeto subscribe to this conversation on GitHub. Already have an account?Sign in.
Reviewers
No reviews
Assignees

@EdwardAngertEdwardAngert

Labels
docs/sitedocs site-related issue/task/feature request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

1 participant
@EdwardAngert

[8]ページ先頭

©2009-2025 Movatter.jp