Skip to content

[information-architecture] Workflow docs navigation omits several documented workflows #455

Description

@github-actions

Information Architecture Findings

1. Main workflow navigation is out of sync with the workflow catalog

Area: Navigation / Consistency
Component(s): mkdocs.yml, docs/workflows/gh-agent-workflows.md, docs/hooks.py

Problem: The primary docs navigation omits several workflows that are documented in the catalog, so users browsing by navigation can miss valid features and get an incomplete mental model of available workflows.

Evidence:

  • mkdocs.yml:36-44 lists Event-driven workflow nav items, but does not include Dependency Review.
  • docs/workflows/gh-agent-workflows.md:57 documents Dependency Review as an available Event-driven workflow.
  • mkdocs.yml:55-65 lists Standalone Scheduled nav items, but does not include Autonomy Atomicity Analyzer, Framework Best Practices, Information Architecture, or Product Manager Impersonator.
  • docs/workflows/gh-agent-workflows.md:85, :89, :90, :92 document those workflows as available.
  • docs/hooks.py:92-113 shows pages are generated from gh-agent-workflows/*/README.md, so docs pages can exist even when not represented in the curated nav.

Suggested improvement:

  • Align mkdocs.yml workflow nav entries with the authoritative “Available workflows” catalog in docs/workflows/gh-agent-workflows.md.
  • Add a docs consistency check (CI/script) that flags nav/catalog drift for workflow slugs.

Suggested Actions

  • Add missing workflow entries to Workflows -> Event-driven and Workflows -> Scheduled -> Standalone Scheduled in mkdocs.yml.
  • Add automated validation to prevent future nav/catalog mismatch.

What is this? | From workflow: Information Architecture

Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not.

Metadata

Metadata

Labels

No labels
No labels

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions