Skip to content

Reorganize workflow docs nav and update landing page#595

Merged
strawgate merged 4 commits intomainfrom
copilot/reorganize-workflow-docs
Mar 8, 2026
Merged

Reorganize workflow docs nav and update landing page#595
strawgate merged 4 commits intomainfrom
copilot/reorganize-workflow-docs

Conversation

Copy link
Contributor

Copilot AI commented Mar 7, 2026

This PR reorganizes workflow documentation around what users want to do first, and updates the landing page to prioritize quick setup.

What changed

Workflows nav (mkdocs.yml)

  • Replaced trigger-based grouping with intent-based sections:
    • Core Workflows: Issue Triage, Mention in Issue, Mention in PR, PR Review
    • Repository Maintenance: duplicate/stale issue handling, PR body updates, issue/PR action maintenance, dependency review, fork review
    • Codebase Maintenance: detector/fixer chaining plus scheduled quality workflows
    • Planning & Insights: planning and analysis workflows
  • Kept Base Workflows and Elastic-specific sections.
  • Moved no-sandbox variants into a dedicated Advanced section.

Landing page (docs/index.md)

  • Replaced the blog-first entry flow with Get Started in 60 Seconds at the top.
  • Added a pre-filled Copilot PAT creation link.
  • Added a setup snippet that sets COPILOT_GITHUB_TOKEN and runs quick-setup.sh.
  • Highlighted the core four workflows in a trigger/description table.
  • Added highlight tables for repository maintenance and codebase maintenance workflows.
  • Moved "Meet the Crew" below setup and workflow guidance.
  • Removed the older lower-page quick-start/catalog sections that duplicated onboarding information.

Motivation


The body of this PR is automatically managed by the Trigger Update PR Body workflow.

Copilot AI and others added 2 commits March 7, 2026 23:07
- Restructure mkdocs.yml nav: Core Workflows (the big four) at top,
  then Repository Maintenance, Codebase Maintenance, Planning & Insights,
  Base Workflows, Advanced, and Elastic-specific sections
- Update docs/index.md landing page: lead with quick-start (PAT hotlink +
  setup script), highlight core four workflows, add repository and codebase
  maintenance summaries, move Meet the Crew below the fold

Co-authored-by: strawgate <6384545+strawgate@users.noreply.github.com>
Co-authored-by: strawgate <6384545+strawgate@users.noreply.github.com>
Copilot AI changed the title [WIP] Reorganize workflow documentation structure Reorganize workflow docs nav and update landing page Mar 7, 2026
@strawgate strawgate marked this pull request as ready for review March 7, 2026 23:21
@coderabbitai
Copy link

coderabbitai bot commented Mar 7, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 112528bc-d2c6-4869-8bd2-d07b3610d001

📥 Commits

Reviewing files that changed from the base of the PR and between b2ec879 and 2fd8256.

📒 Files selected for processing (2)
  • docs/index.md
  • mkdocs.yml

📝 Walkthrough

Walkthrough

The pull request reorganizes workflow documentation by restructuring the landing page from narrative content to task-focused sections (Get Started, Core Workflows, Repository Maintenance, Codebase Maintenance) and restructuring the navigation file to introduce new workflow categories. Core Workflows now groups issue triage, mention workflows, and PR review. Repository Maintenance and Codebase Maintenance sections are newly added, with multiple workflow entries reparented and consolidated under these categories.

Possibly related PRs

🚥 Pre-merge checks | ✅ 2
✅ Passed checks (2 passed)
Check name Status Explanation
Linked Issues check ✅ Passed PR successfully implements all four core objectives from issue #593: promotes four core workflows in nav, groups repository-maintenance workflows, groups codebase-maintenance workflows, and updates landing page with quick-start focus.
Out of Scope Changes check ✅ Passed All changes are directly aligned with issue #593 objectives. mkdocs.yml and docs/index.md modifications exclusively reorganize navigation and landing page as specified.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch copilot/reorganize-workflow-docs
  • 🛠️ Update Documentation: Commit on current branch
  • 🛠️ Update Documentation: Create PR

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions github-actions bot added the small_boom Small PR blast radius; usually low human-review need label Mar 7, 2026
@strawgate strawgate merged commit 8b55cca into main Mar 8, 2026
22 checks passed
@strawgate strawgate deleted the copilot/reorganize-workflow-docs branch March 8, 2026 00:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

small_boom Small PR blast radius; usually low human-review need

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Reorganize workflow docs

2 participants