Repository navigation
Description
Current Status
π΄ Priority: CRITICAL
π‘ Progress: Not Started
Epic: #1546 (Release Process Redesign)
Phase: 1 β Critical Fixes
Last Updated: 2026-08-05
Task Summary
Remove broken workflow badges from documentation. Several docs reference workflow status badges that no longer work, causing validation errors and reducing documentation credibility.
Acceptance Criteria
- All broken badges identified in documentation
- Broken badge references removed from docs
- Documentation validates without errors
- Lint checks pass
- Alternative status indicators implemented (if needed)
- Documentation remains readable and informative
Steps / Checklist
-
Audit broken badges
- Scan all .md files in docs/ and .github/ for badge references
- Identify which badges are broken (404s, dead links, etc.)
- List affected files and line numbers
- Determine if badges were to workflow statuses
-
Remove broken references
- Delete broken badge markup from documentation
- Check for orphaned badge definitions
- Ensure surrounding text flows naturally without badge
-
Replace with alternatives
- Consider text-based status indicators (e.g., "Status: Active")
- Update RELEASE_PROCESS.md status section
- Add links to actual workflow files where relevant
- Reference badge sources if re-adding them
-
Validate fixes
- Run markdown lint (npm run lint:md)
- Verify all links work (npm run validate:links)
- Check frontmatter validation
- Manual review of affected docs
Dependencies
- CHILD-001 (Authorization Gating) β may reference in workflow status section
- CHILD-002 (Release Flow) β affects RELEASE_PROCESS.md
- Documentation audit findings from AUDIT_REPORT.md
Additional Context
Related Audit Finding:
Critical issue #3 from AUDIT_REPORT.md: "Broken workflow badges in documentation"
Affected Documents (likely):
- docs/RELEASE_PROCESS.md
- docs/CHANGELOG_AUTOMATION.md
- docs/AUTOMATION.md
- .github/projects/active/release-process-redesign-2026-08-05/README.md
Referenced Issues:
- epic: release-agents - Deliver portable release and changelog agentsΒ #1546 (Parent Epic)
- [CHILD-001] Fix Authorization Gating FailureΒ #1547 (CHILD-001: Authorization Gating)
- [CHILD-002] Fix Release Flow ArchitectureΒ #1548 (CHILD-002: Release Flow)
Definition of Ready (DoR)
- Broken badges identified in audit report
- Affected files documented
- Team agrees on removal approach
- Validation tools configured
Definition of Done (DoD)
- All broken badge references removed from docs
- Documentation re-validated (no lint errors)
- Broken link checks pass
- Alternative status indicators added where helpful
- Code merged to develop
- No regressions in other docs
- Related: chore: Footer Automation Script Redesign (Phase 3, Task 2)Β #1531 (Broken Badges Audit)
Verification
Test Case 1: Lint Pass
- Trigger: Run
npm run lint:md - Expected: No markdown errors in affected files
Test Case 2: Link Validation
- Trigger: Run link validation on docs/
- Expected: No 404 errors for documentation links
Test Case 3: Document Review
- Trigger: Manual review of updated docs
- Expected: Documents read naturally without badge references
Test Case 4: CI Passes
- Trigger: Push changes to develop
- Expected: CI checks pass (lint, links, frontmatter, etc.)
Metadata
Metadata
Assignees
Type
Fields
Priority
None yet
Activity
linear-code commentedon Aug 5, 2026
LS-2286
github-actions commentedon Aug 5, 2026
β Template check passed after update. Thanks for fixing the issue body.
github-actions commentedon Aug 5, 2026
β±οΈ Aging and SLA annotation
Maintained by project-meta-sync workflow.
docs: Update release process project with issue creation status and sβ¦
docs: Add Phase 1 detailed implementation plan for critical fixes
10 remaining items
docs: Add comprehensive GitHub issue linking to Phase 5A project
github-actions commentedon Sep 8, 2026
This issue has labels that are not in the canonical taxonomy:
migrate:priority:criticalmigrate:priority:normalmigrate:type:documentationmigrate:release:patchValid Canonical Labels
Please use labels with a prefix from the canonical taxonomy:
type:bug,type:feature,type:task,type:documentation, etc.status:needs-triage,status:in-progress,status:done, etc.priority:critical,priority:high,priority:normal,priority:lowarea:ci,area:docs,area:labels,area:security, etc.meta:needs-changelog,meta:duplicate,meta:blocked, etc.For the complete list, see .github/labels.yml.