Skip to content

Testing the AI doc pipeline - #7

Open
Teebarh wants to merge 10 commits into
mainfrom
toyibat
Open

Testing the AI doc pipeline#7
Teebarh wants to merge 10 commits into
mainfrom
toyibat

Conversation

@Teebarh

@Teebarh Teebarh commented Jul 23, 2026

Copy link
Copy Markdown
Contributor

No description provided.

@vercel

vercel Bot commented Jul 23, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
task-manager-api-documentation Ready Ready Preview Aug 3, 2026 11:15pm

@Teebarh

Teebarh commented Aug 3, 2026

Copy link
Copy Markdown
Contributor Author

@claude

@Teebarh

Teebarh commented Aug 3, 2026

Copy link
Copy Markdown
Contributor Author

@claude

@github-actions

github-actions Bot commented Aug 3, 2026

Copy link
Copy Markdown

This PR touches the style guide or howtos. Check whether AGENTS.md and related instruction files still match. Remove the review-agent-instructions label once checked.

@Teebarh

Teebarh commented Aug 4, 2026

Copy link
Copy Markdown
Contributor Author

@claude

@claude

claude Bot commented Aug 4, 2026

Copy link
Copy Markdown

Claude encountered an error —— View job

Failed with exit code 128

I'll analyze this and get back to you.

@Teebarh

Teebarh commented Aug 4, 2026

Copy link
Copy Markdown
Contributor Author

@claude

@claude

claude Bot commented Aug 4, 2026

Copy link
Copy Markdown

Claude encountered an error —— View job


I'll analyze this and get back to you.

@Teebarh

Teebarh commented Aug 4, 2026

Copy link
Copy Markdown
Contributor Author

@claude

@claude

claude Bot commented Aug 4, 2026

Copy link
Copy Markdown

Claude encountered an error —— View job


I'll analyze this and get back to you.

@Teebarh

Teebarh commented Aug 4, 2026

Copy link
Copy Markdown
Contributor Author

@claude

@claude

claude Bot commented Aug 4, 2026

Copy link
Copy Markdown

Claude finished @Teebarh's task —— View job


Review — Testing the AI doc pipeline

  • Gather context on PR changes
  • Determine request from trigger comment
  • Provide response

The trigger comment had no text, so here's a review of the PR's substantive changes.

⚠️ Likely root cause of previous @claude failures

.github/workflows/ai-review.yml had its actions/checkout@v6 step removed (and the model: claude-sonnet-5 input dropped) in this PR:

-      - name: Checkout repository
-        uses: actions/checkout@v6
-        with:
-          fetch-depth: 1
-
       - uses: anthropics/claude-code-action@beta
         with:
           anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
-          model: claude-sonnet-5

Without a checkout step, the action has no git repository to operate in, which matches the Failed with exit code 128 errors seen on earlier @claude runs in this thread (128 is a standard git "fatal" exit code, e.g. not a git repository). I can't edit this file myself (workflow file permissions), but this is worth restoring the checkout step to fix the pipeline going forward.

docs/api/tasks.md (comment endpoints, +104 lines)

  • Follows the existing reference-table pattern (Method/Endpoint/Description/Auth/Role) correctly.
  • Good use of the repo's / convention for genuinely unconfirmed details (comment id vs _id, response envelope shape, 403 body text, max length on text). This is exactly what CLAUDE.md asks for when source material is ambiguous.
  • One inconsistency worth flagging: the new comment objects use id while every other resource on this page (and in docs/api/users.md) uses _id — already correctly called out via the GAP comment, so no action needed unless the underlying API is confirmed.
  • Headings look sentence-cased already except pre-existing ones (Endpoints Overview, Task Structure, Common Error Responses) — those predate this PR's diff, so out of scope per the "minimal diffs" rule.

README.md

  • Changed "a modern static website generator" → "which is a modern static website generator." This is the Docusaurus boilerplate README (not docs/ content), so the API-doc style rules don't strictly apply, but it does introduce a slightly wordier construction with no clear benefit.

Everything else (Vale style rules, .claude/skills, .claude/commands, translate scripts, scratch/, .claude/workspace/DOC-101/*)

This is a large amount of tooling/infrastructure (Vale linting config, Claude skills/commands, a translation script, and scratch/workspace artifacts) bundled into a PR titled "Testing the AI doc pipeline." A few notes:

  • scratch/content/**/intro.md and .claude/workspace/DOC-101/*.md look like generated test artifacts rather than intentional documentation — worth confirming whether these should ship to main or be excluded.
  • vale-test.md at the repo root also looks like a throwaway test file.
  • None of these touch docs/api/ content directly, so they don't conflict with the doc style rules, but given CLAUDE.md's "minimal diffs" and "prefer targeted edits" guidance, this PR mixes a lot of unrelated infra with the one real content change (the comment endpoints). Splitting infra/tooling from content PRs would make future reviews easier.

No code changes were made — this was a review-only request.


Branch: toyibat · Job run

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant