Skip to content

doc-check: four cases where it passes when it should fail #908

Open

Description

@scuttletoby

Follow-up from the lens review of #874 (#874 (comment)). Each was reproduced in a small test repo.

  1. A change that turns AGENTS.md into a symlink to a large file: the file is not checked at all, and the run passes.
  2. An instruction file with one non-UTF-8 byte only gets a warning, so its size limit is skipped.
  3. A deleted or renamed doc leaves broken links in files the change did not touch, and the run passes. The README lists this as not covered.
  4. Files with CRLF line endings are measured about 1 byte per line too small.

Nits:

  • Links inside inline code, or inside a code block in a list item, are reported as broken.
  • A link ending in a query (?plain=1) is reported as broken.
  • The README's "cannot loosen" claim covers only the config file, not the workflow file.

Plan: one writer fixes 1, 2 and 4 so that each fails closed, with a test for each that fails when the fix is undone. Item 3 is a choice: either scan the whole tree for links to removed docs, or keep it as a documented gap. My recommendation is to scan the whole tree, because the doc set is small.

🤖 Generated with Claude Code

Activity

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions