Skip to content

Docs: add contributor's guide to the Guide section of the docs site #274

New issue
New issue
Closed
#275
Closed
Docs: add contributor's guide to the Guide section of the docs site#274
#275
Labels
go:needs-researchNeeds investigationsquadSquad triage inbox — Lead will assign to a membertype:docsDocumentation work

Description

@bradygaster
bradygaster
opened on Mar 8, 2026

Problem

The \CONTRIBUTING.md\ file exists at the repo root (308 lines of solid contributor guidance) but it is not included in the docs site at https://bradygaster.github.io/squad/. The Guide section currently has tips-and-tricks, sample-prompts, and personal-squad — no contributor's guide.

\docs/community.md\ references ../CONTRIBUTING.md\ with a relative link that doesn't resolve on the published site.

Expected

A Contributing page should appear in the Guide section of the docs site sidebar navigation, making it easy for contributors to find.

Implementation

  1. Create \docs/guide/contributing.md\ — either copy \CONTRIBUTING.md\ content or adapt it for the docs site format (with proper frontmatter/title)
  2. Add 'contributing'\ to \SECTION_ORDER.guide\ in \docs/build.js\
  3. Update \docs/community.md\ links to point to the new docs page instead of ../CONTRIBUTING.md\
  4. Verify the page renders at https://bradygaster.github.io/squad/guide/contributing.html

Acceptance Criteria

  • Contributing page visible in Guide section sidebar
  • Content matches or improves upon \CONTRIBUTING.md\
  • No broken links to the old relative path
  • Build succeeds with the new page

Activity

  1. bradygaster
    added
    squadSquad triage inbox — Lead will assign to a member
    type:docsDocumentation work
    squad:mcmanus
    on Mar 8, 2026
  2. github-actions
    added
    squad:cheritto
    go:needs-researchNeeds investigation
    on Mar 8, 2026

  3. github-actions commented on Mar 8, 2026

    @github-actions
    github-actionsBot
    on Mar 8, 2026 – with GitHub Actions
    Contributor

    📋 Assigned to McManus (DevRel)

    Issue: #274 — Docs: add contributor's guide to the Guide section of the docs site

    McManus will pick this up in the next Copilot session.

    For Copilot coding agent: If enabled, this issue will be worked automatically.
    Otherwise, start a Copilot session and say:
    McManus, work on issue #274

  4. github-actions commented on Mar 8, 2026

    @github-actions
    github-actionsBot
    on Mar 8, 2026 – with GitHub Actions
    Contributor

    🏗️ Squad Triage — Keaton (Lead)

    Issue: #274 — Docs: add contributor's guide to the Guide section of the docs site
    Assigned to: Cheritto (TUI Engineer)
    Reason: Issue relates to frontend/UI work

    @copilot evaluation: 🔴 Not suitable — issue involves work outside the coding agent's capability profile.

    Team roster:

    • Keaton (Lead) → label: squad:keaton
    • Verbal (Prompt Engineer) → label: squad:verbal
    • Fenster (Core Dev) → label: squad:fenster
    • Hockney (Tester) → label: squad:hockney
    • McManus (DevRel) → label: squad:mcmanus
    • Kujan (SDK Expert) → label: squad:kujan
    • Edie (TypeScript Engineer) → label: squad:edie
    • Trejo (Release Manager) → label: squad:trejo
    • Drucker (CI/CD Engineer) → label: squad:drucker
    • Fortier (Node.js Runtime) → label: squad:fortier
    • Rabin (Distribution) → label: squad:rabin
    • Baer (Security) → label: squad:baer
    • Redfoot (Graphic Designer) → label: squad:redfoot
    • Strausz (VS Code Extension) → label: squad:strausz
    • Saul (Aspire & Observability) → label: squad:saul
    • Kovash (REPL & Interactive Shell) → label: squad:kovash
    • Marquez (CLI UX Designer) → label: squad:marquez
    • Cheritto (TUI Engineer) → label: squad:cheritto
    • Breedan (E2E Test Engineer) → label: squad:breedan
    • Nate (Accessibility Reviewer) → label: squad:nate
    • Waingro (Product Dogfooder) → label: squad:waingro
    • Ralph (Work Monitor) → label: squad:ralph
    • @copilot (Coding Agent) → label: squad:copilot

    To reassign, remove the current squad:* label and add the correct one.

  5. bradygaster
    added 2 commits that reference this issue on Mar 8, 2026

    docs: add contributor guide to docs site Guide section (#274)

    cbeaea9

    docs: add contributor guide to docs site Guide section (#274)

    7d28b12
  6. bradygaster
    closed this as completedin #275on Mar 8, 2026
  7. bradygaster
    added 2 commits that reference this issue on Mar 8, 2026

    docs(ai-team): Session log for McManus contributing guide

    78e0f8d

    docs: add Squad Contributors Guide page (#276) (#277)

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    go:needs-researchNeeds investigationsquadSquad triage inbox — Lead will assign to a membertype:docsDocumentation work

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions