diff --git a/.github/workflows/update-docs.yml b/.github/workflows/update-docs.yml index 94e3ad0c..c4045689 100644 --- a/.github/workflows/update-docs.yml +++ b/.github/workflows/update-docs.yml @@ -34,57 +34,60 @@ jobs: const revisionReason = process.env.REVISION_REASON; const actor = process.env.ACTOR; + const bodyLines = [ + '## Documentation Update Request', + '', + '**Reason**: ' + revisionReason, + '', + '**Triggered by**: @' + actor, + '', + '**Action Required**:', + 'This workflow creates a reminder to update the GitHub Pages documentation using the `github-pages-docs` agent in Claude Code.', + '', + '### Steps to Update Documentation:', + '', + '1. **Open Claude Code** in this repository', + '2. **Run the command**:', + ' ```', + ' Use the @agent-github-pages-docs to revise all documentation in docs/ based on:', + ' - Latest CLAUDE.md updates', + ' - Bootstrap feature implementation status', + ' - Recent code changes', + ' - ' + revisionReason, + ' ```', + '3. **Review the changes** generated by the agent', + '4. **Commit and push** to this branch or create a PR', + '5. **Close this issue** when complete', + '', + '### Why Manual Update?', + '', + 'The `github-pages-docs` agent requires Claude Code\'s specialized documentation capabilities. We\'re tracking this issue to ensure documentation stays synchronized with codebase changes.', + '', + '### Future Automation', + '', + 'See `BACKLOG.md` - "Documentation Source Truth and Cascade System" (P2) for plans to automate this workflow.', + '', + '---', + '', + '**Related Files**:', + '- `docs/` - GitHub Pages documentation', + '- `CLAUDE.md` - Project guide (source of truth)', + '- `README.md` - User-facing documentation', + '- `agent-ready-codebase-attributes.md` - Research report (source of truth)', + '', + '**Labels**: documentation, automation-needed, agent-task' + ]; + const issue = await github.rest.issues.create({ owner: context.repo.owner, repo: context.repo.repo, title: 'docs: Update GitHub Pages documentation', - body: `## Documentation Update Request - -**Reason**: ${revisionReason} - -**Triggered by**: @${actor} - -**Action Required**: -This workflow creates a reminder to update the GitHub Pages documentation using the \`github-pages-docs\` agent in Claude Code. - -### Steps to Update Documentation: - -1. **Open Claude Code** in this repository -2. **Run the command**: - \`\`\` - Use the @agent-github-pages-docs to revise all documentation in docs/ based on: - - Latest CLAUDE.md updates - - Bootstrap feature implementation status - - Recent code changes - - ${revisionReason} - \`\`\` -3. **Review the changes** generated by the agent -4. **Commit and push** to this branch or create a PR -5. **Close this issue** when complete - -### Why Manual Update? - -The \`github-pages-docs\` agent requires Claude Code's specialized documentation capabilities. We're tracking this issue to ensure documentation stays synchronized with codebase changes. - -### Future Automation - -See \`BACKLOG.md\` - "Documentation Source Truth and Cascade System" (P2) for plans to automate this workflow. - ---- - -**Related Files**: -- \`docs/\` - GitHub Pages documentation -- \`CLAUDE.md\` - Project guide (source of truth) -- \`README.md\` - User-facing documentation -- \`agent-ready-codebase-attributes.md\` - Research report (source of truth) - -**Labels**: documentation, automation-needed, agent-task - `, + body: bodyLines.join('\n'), labels: ['documentation', 'automation-needed', 'agent-task'] }); core.setOutput('issue_number', issue.data.number); - core.notice(`Created documentation update issue #${issue.data.number}`); + core.notice('Created documentation update issue #' + issue.data.number); return issue.data.number; - name: Check for recent source file changes @@ -100,11 +103,11 @@ See \`BACKLOG.md\` - "Documentation Source Truth and Cascade System" (P2) for pl || true) if [ -n "$CHANGES" ]; then - echo "has_changes=true" >> $GITHUB_OUTPUT + echo "has_changes=true" >> "$GITHUB_OUTPUT" # Save to file to avoid injection issues echo "$CHANGES" > /tmp/recent_changes.txt else - echo "has_changes=false" >> $GITHUB_OUTPUT + echo "has_changes=false" >> "$GITHUB_OUTPUT" fi - name: Comment with recent changes @@ -115,20 +118,23 @@ See \`BACKLOG.md\` - "Documentation Source Truth and Cascade System" (P2) for pl const fs = require('fs'); const recentChanges = fs.readFileSync('/tmp/recent_changes.txt', 'utf-8'); + const commentLines = [ + '### Recent Changes to Source Files', + '', + 'The following commits may affect documentation:', + '', + '```', + recentChanges.trim(), + '```', + '', + 'Please ensure the documentation agent incorporates these changes.' + ]; + await github.rest.issues.createComment({ owner: context.repo.owner, repo: context.repo.repo, issue_number: ${{ steps.create-issue.outputs.issue_number }}, - body: `### Recent Changes to Source Files - -The following commits may affect documentation: - -\`\`\` -${recentChanges} -\`\`\` - -Please ensure the documentation agent incorporates these changes. - ` + body: commentLines.join('\n') }); - name: Summary diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index f21ec476..7bb9f83f 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -12,6 +12,11 @@ repos: - id: check-json - id: detect-private-key + - repo: https://github.com/rhysd/actionlint + rev: v1.7.4 + hooks: + - id: actionlint + - repo: https://github.com/psf/black rev: 24.1.1 hooks: diff --git a/docs/_data/leaderboard.json b/docs/_data/leaderboard.json index 8add700e..dba3d6f1 100644 --- a/docs/_data/leaderboard.json +++ b/docs/_data/leaderboard.json @@ -1,5 +1,5 @@ { - "generated_at": "2025-12-04T19:24:27.444845Z", + "generated_at": "2025-12-05T17:38:42.696860Z", "total_repositories": 2, "overall": [ { @@ -8,10 +8,10 @@ "name": "agentready", "score": 78.6, "tier": "Gold", - "language": "Python", - "size": "Medium", + "language": "Unknown", + "size": "Unknown", "last_updated": "2025-12-03", - "url": "https://github.com/ambient-code/agentready", + "url": "git@github.com:ambient-code/agentready.git", "agentready_version": "2.9.0", "research_version": "1.0.0", "history": [ @@ -24,7 +24,7 @@ ], "rank": 1, "lang_rank": { - "Python": 1 + "Unknown": 1 } }, { @@ -33,10 +33,10 @@ "name": "quay", "score": 51.0, "tier": "Bronze", - "language": "Python", - "size": "Large", + "language": "Unknown", + "size": "Unknown", "last_updated": "2025-12-04", - "url": "https://github.com/quay/quay", + "url": "git@github.com:quay/quay.git", "agentready_version": "2.12.2", "research_version": "1.0.0", "history": [ @@ -49,22 +49,22 @@ ], "rank": 2, "lang_rank": { - "Python": 2 + "Unknown": 2 } } ], "by_language": { - "Python": [ + "Unknown": [ { "repo": "ambient-code/agentready", "org": "ambient-code", "name": "agentready", "score": 78.6, "tier": "Gold", - "language": "Python", - "size": "Medium", + "language": "Unknown", + "size": "Unknown", "last_updated": "2025-12-03", - "url": "https://github.com/ambient-code/agentready", + "url": "git@github.com:ambient-code/agentready.git", "agentready_version": "2.9.0", "research_version": "1.0.0", "history": [ @@ -77,7 +77,7 @@ ], "rank": 1, "lang_rank": { - "Python": 1 + "Unknown": 1 } }, { @@ -86,10 +86,10 @@ "name": "quay", "score": 51.0, "tier": "Bronze", - "language": "Python", - "size": "Large", + "language": "Unknown", + "size": "Unknown", "last_updated": "2025-12-04", - "url": "https://github.com/quay/quay", + "url": "git@github.com:quay/quay.git", "agentready_version": "2.12.2", "research_version": "1.0.0", "history": [ @@ -102,23 +102,23 @@ ], "rank": 2, "lang_rank": { - "Python": 2 + "Unknown": 2 } } ] }, "by_size": { - "Medium": [ + "Unknown": [ { "repo": "ambient-code/agentready", "org": "ambient-code", "name": "agentready", "score": 78.6, "tier": "Gold", - "language": "Python", - "size": "Medium", + "language": "Unknown", + "size": "Unknown", "last_updated": "2025-12-03", - "url": "https://github.com/ambient-code/agentready", + "url": "git@github.com:ambient-code/agentready.git", "agentready_version": "2.9.0", "research_version": "1.0.0", "history": [ @@ -131,21 +131,19 @@ ], "rank": 1, "lang_rank": { - "Python": 1 + "Unknown": 1 } - } - ], - "Large": [ + }, { "repo": "quay/quay", "org": "quay", "name": "quay", "score": 51.0, "tier": "Bronze", - "language": "Python", - "size": "Large", + "language": "Unknown", + "size": "Unknown", "last_updated": "2025-12-04", - "url": "https://github.com/quay/quay", + "url": "git@github.com:quay/quay.git", "agentready_version": "2.12.2", "research_version": "1.0.0", "history": [ @@ -158,7 +156,7 @@ ], "rank": 2, "lang_rank": { - "Python": 2 + "Unknown": 2 } } ]