Skip to content

Conversation

@mnvr
Copy link
Member

@mnvr mnvr commented Oct 10, 2025

No description provided.

@mnvr mnvr requested a review from ua741 October 10, 2025 07:47
@mnvr mnvr temporarily deployed to workflow-security-review October 10, 2025 07:47 — with GitHub Actions Inactive
@claude
Copy link

claude bot commented Oct 10, 2025

Code Review

Summary

This PR removes the .github/workflows/docs-lint.yml workflow file that was running Prettier checks on the docs directory.

Analysis

Code Quality:

  • Clean deletion with no loose ends
  • No breaking changes to other workflows or dependencies

Considerations:

  1. Loss of Formatting Enforcement:

    • The workflow was running 'yarn pretty:check' to enforce Prettier formatting on docs
    • After this removal, docs changes will no longer be automatically checked for formatting consistency
    • The package.json in docs/ still has prettier dependency and pretty:check script, but it won't be enforced in CI
  2. Potential Inconsistency:

    • Without automated checks, formatting inconsistencies may creep into documentation over time
    • Other parts of the codebase (web, mobile, etc.) still have lint workflows
  3. Missing Context:

    • The PR has no description explaining why this check is being removed
    • Was this intentional? Was Prettier causing issues? Is formatting being handled elsewhere?

Questions for Consideration:

  1. Is there a replacement mechanism for enforcing docs formatting, or is manual formatting now acceptable?
  2. Should the prettier devDependency and scripts in docs/package.json also be removed if they're no longer used in CI?
  3. Was this causing friction in the development workflow that justified its removal?

Recommendation:

The code change itself is fine, but I'd suggest:

  • Adding a brief explanation in the PR description about why this check is being removed
  • Considering whether to keep Prettier as a manual tool (yarn pretty for local formatting) or remove it entirely
  • Updating any contributing documentation if formatting expectations have changed

Review performed by Claude Code

@mnvr mnvr merged commit 547be6a into main Oct 10, 2025
5 checks passed
@mnvr mnvr deleted the yp branch October 10, 2025 07:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants