Skip to content

[CHILD-003] Remove Broken Workflow BadgesΒ #1549

Closed

Description

@ashleyshaw

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

  1. 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
  2. Remove broken references

    • Delete broken badge markup from documentation
    • Check for orphaned badge definitions
    • Ensure surrounding text flows naturally without badge
  3. 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
  4. 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:


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)


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.)

Activity

  1. linear-code commented on Aug 5, 2026

    @linear-code
  2. github-actions commented on Aug 5, 2026

    @github-actions
    Contributor

    βœ… Template check passed after update. Thanks for fixing the issue body.

  3. github-actions commented on Aug 5, 2026

    @github-actions
    Contributor

    ⏱️ Aging and SLA annotation

    • Age: 0 day(s)
    • SLA state: Within SLA
    • Thresholds: warn at 7 days, breach at 14 days
    • Last updated: 2026-08-05T18:16:24.485Z

    Maintained by project-meta-sync workflow.

  4. added this to the v1.0 milestone on Aug 5, 2026
  5. 10 remaining items

  6. self-assigned this
    on Sep 8, 2026
  7. github-actions commented on Sep 8, 2026

    @github-actions
    Contributor

    ⚠️ Bare Labels Detected

    This issue has labels that are not in the canonical taxonomy:

    • migrate:priority:critical
    • migrate:priority:normal
    • migrate:type:documentation
    • migrate:release:patch

    Valid Canonical Labels

    Please use labels with a prefix from the canonical taxonomy:

    • Type: type:bug, type:feature, type:task, type:documentation, etc.
    • Status: status:needs-triage, status:in-progress, status:done, etc.
    • Priority: priority:critical, priority:high, priority:normal, priority:low
    • Area: area:ci, area:docs, area:labels, area:security, etc.
    • Meta: meta:needs-changelog, meta:duplicate, meta:blocked, etc.

    For the complete list, see .github/labels.yml.

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

Metadata

Metadata

Assignees

Fields

Priority

None yet

Projects

No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions