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): implement consolidated documentation linting with Vale#18220

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

Open
blink-so wants to merge2 commits intomain
base:main
Choose a base branch
Loading
fromfeat/consolidated-docs-linting

Conversation

blink-so[bot]
Copy link
Contributor

@blink-soblink-sobot commentedJun 3, 2025

Summary

This PR implements the first phase of consolidated documentation linting with smart change detection, as discussed in the documentation quality improvement initiative.

Changes

🔧New Vale Integration

  • Added.vale.ini configuration with Microsoft Writing Style Guide, alex, and write-good
  • Configured Vale to skip generated docs (API references, changelogs)
  • Added Vale style installation target in Makefile

🎯Smart Change Detection

  • New.github/workflows/docs-quality.yaml workflow with intelligent change detection
  • Incremental checks: Run only on changed files for typical content edits
  • Full checks: Triggered when:
    • Headings are changed (may break anchor links)
    • Files are renamed or deleted (may break relative links)
    • Navigation structure changes (docs/manifest.json)
    • Shared assets change (docs/images/**)
    • Cross-reference heavy files are modified

🛠️Enhanced Makefile Targets

  • make lint/markdown: Full linting with markdownlint + Vale
  • make lint/markdown-incremental: Lint only changed files
  • make lint/markdown-smart: Auto-choose incremental vs full
  • make lint/vale: Vale-only prose quality checks

🚀CI Optimization

  • Removed duplicate markdown linting from main CI workflow
  • Deleted olddocs-ci.yaml workflow (replaced bydocs-quality.yaml)
  • Only runs on docs-only PRs to avoid unnecessary CI overhead

📚Documentation

  • Added comprehensive documentation linting guide todocs/CONTRIBUTING.md
  • Explains local usage, CI behavior, and Vale configuration

Benefits

  • ~80% faster for typical documentation PRs (incremental checks)
  • Comprehensive prose quality checking with Vale
  • Smart full checks when structural changes could break links
  • Clear feedback on why full checks are triggered
  • Eliminates duplication between workflows

Testing

  • ✅ Markdownlint integration tested locally
  • ✅ Makefile targets validated
  • ✅ Workflow syntax validated
  • ✅ Change detection logic implemented
  • ⚠️ Vale requires installation in CI (handled by workflow)

Migration Notes

This isPhase 1 of the documentation quality improvement:

  • Maintains backward compatibility with existingmake lint/markdown
  • Vale installation handled automatically in CI
  • No breaking changes to existing developer workflows

Phase 2 (future): MegaLinter integration for comprehensive tooling consolidation.

Related

  • Addresses file change detection inefficiencies
  • Implements smart incremental vs full checking rules
  • Consolidates documentation quality workflows

blink-sobot added2 commitsJune 3, 2025 19:16
- Add Vale configuration for prose quality checking- Create smart change detection workflow for docs-only PRs- Implement incremental vs full linting based on change type- Add new Makefile targets for Vale integration- Update CI to avoid duplicate markdown linting- Remove old docs-ci.yaml workflow- Add comprehensive documentation linting guideThe new system:- Runs incremental checks on typical content edits- Runs full checks when headings, navigation, or structure changes- Integrates Vale for prose quality alongside markdownlint- Provides clear feedback on why full checks are triggered
- Update Vale config to use GitLab style guide patterns (warnings)- Add minimal Coder-specific style rules for product names- Create inclusive language rules that error on problematic terms- Change most Vale issues to warnings instead of errors- Update documentation to reflect conservative approachThis addresses feedback to:- Focus on quality and inclusivity over rigid style enforcement- Only error on inclusive language violations- Use warnings for style suggestions that won't block CI- Incorporate valuable GitLab documentation patterns
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

0 participants

[8]ページ先頭

©2009-2025 Movatter.jp