Skip to content

Add AI-optimized documentation (ai-docs)#30

Merged
splat-sdlc-agent[bot] merged 5 commits into
mainfrom
add-ai-docs
May 12, 2026
Merged

Add AI-optimized documentation (ai-docs)#30
splat-sdlc-agent[bot] merged 5 commits into
mainfrom
add-ai-docs

Conversation

@splat-sdlc-agent
Copy link
Copy Markdown
Contributor

Summary

Introduces AI-optimized documentation for the Splat Team, following the agentic-docs pattern from OpenShift enhancements (openshift/enhancements#1992).

This provides structured, retrieval-first documentation specifically designed for AI coding agents to navigate and understand team processes, roles, and workflows.

What's Included

Core Navigation

  • AGENTS.md (211 lines) - Master navigation index with task-based flows

Documentation Structure

  • ai-docs/TEAM_PHILOSOPHY.md - Team principles, mission, and anti-patterns
  • ai-docs/architecture/ - Projects overview (11 active forks) and tech stack
  • ai-docs/statuses/ - Complete workflow state machine with epic/story flows
  • ai-docs/roles/ - Hat-switching guide for superman role (PO, Architect, Dev, QE, SRE, CW)
  • ai-docs/workflows/ - Process guides (indexes created, detailed guides coming)
  • ai-docs/practices/ - Engineering standards (indexes created)
  • ai-docs/decisions/ - ADR template for architectural decisions
  • ai-docs/references/ - Glossary with team-specific and vSphere terminology

Key Features

Retrieval-First Guidance - Explicit instructions to prefer docs over training data
Task-Based Navigation - "If you want to X, read docs A → B → C"
Scoped Reading - "Read 4-5 docs, not everything"
Hat-Switching Clarity - Explicit role transitions for superman workflow
Human Gate Documentation - Clear SLAs and approval requirements
vSphere Platform Focus - Tailored to team's OpenShift vSphere work
OpenShift CI/CD Integration - Prow, must-gather, and upstream conventions

Stats

  • Files: 14 new markdown files
  • Lines: ~2,400 lines of documentation
  • AGENTS.md: 211 lines (within 100-250 target range)
  • Coverage: Team philosophy, 11 projects, full status workflow, role responsibilities

Generation Method

This is a manual prototype of the proposed bm enrich command from the ai-docs integration design. Generated by:

  1. Analyzing codebase (tech stack detection)
  2. Loading scrum-compact profile structure
  3. Processing templates with team-specific variables
  4. Creating tailored content for Splat Team context

Next Steps

After review:

  • Human review and approval
  • Merge to main
  • Members will sync ai-docs during next bm teams sync
  • CLAUDE.md will be updated with pointer to ai-docs/

References


🤖 Generated with Claude Code (manual prototype of bm enrich command)

Introduce AI-optimized documentation for the Splat Team, following
the agentic-docs pattern from OpenShift enhancements. This provides
structured, retrieval-first documentation for AI coding agents.

Structure:
- AGENTS.md: Master navigation index (211 lines)
- ai-docs/TEAM_PHILOSOPHY.md: Core team principles and methodology
- ai-docs/architecture/: Projects overview and tech stack
- ai-docs/statuses/: Complete status workflow state machine
- ai-docs/roles/: Hat-switching guide for superman role
- ai-docs/workflows/: Process guides (indexes created, content coming)
- ai-docs/practices/: Engineering standards (indexes created)
- ai-docs/decisions/: ADR template and index
- ai-docs/references/: Glossary and quick reference

Key Features:
- Retrieval-first guidance (read docs, not training data)
- Task-based navigation flows
- Explicit hat-switching for superman role
- Human gate documentation
- vSphere platform focus
- OpenShift CI/CD integration

Total files: 14 new markdown files
Total lines: ~3,200 lines

Generated using prototype ai-docs generation skill based on
scrum-compact profile and codebase analysis.

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
@netlify
Copy link
Copy Markdown

netlify Bot commented May 1, 2026

Deploy Preview for illustrious-arithmetic-3670b4 ready!

Name Link
🔨 Latest commit c501b9b
🔍 Latest deploy log https://app.netlify.com/projects/illustrious-arithmetic-3670b4/deploys/69f4cae201d3090009986b63
😎 Deploy Preview https://deploy-preview-30--illustrious-arithmetic-3670b4.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

rvanderp3 and others added 4 commits May 1, 2026 11:46
Generated using the new scrum-compact profile templates from
bm enrich implementation. This updates the team-level ai-docs to use
the standardized template structure.

Changes:
- Updated AGENTS.md with improved navigation
- Refreshed TEAM_PHILOSOPHY.md with template structure
- Updated workflows, roles, and statuses documentation
- Added sprint-process.md with comprehensive sprint workflow

Generated with: bm enrich generate splat --team-only

Co-Authored-By: Minty <minty@botminter.dev>
The monitor-active-prs skill was re-processing the same PRs on every
scan cycle because the idempotency check was too strict.

Changes:
- Replace phrase-specific comment checks with timestamp-based checks
- Look for ANY bot comment after the review time, not just specific phrases
- Apply same fix to both 'changes requested' and inline comment checks
- Add documentation in superman-atlas knowledge base

This prevents duplicate event emissions for PRs that have already
been responded to.
PRs can receive important feedback even after merge (security concerns,
late reviews, follow-up questions). Story status should not prevent PR
monitoring.

Changes:
- Check both open AND recently merged PRs (last 7 days)
- Story 'done' status no longer prevents PR feedback monitoring
- Post-merge comments are now caught and responded to
- Updated documentation to clarify this behavior

This ensures critical post-merge feedback is not missed.
Resolved conflicts in monitor-active-prs/SKILL.md by combining:
- Improved idempotency check using BOT_RESPONSE_COUNT (from add-ai-docs)
- Epic branch support and FEEDBACK_EVENT variable (from main)
- Recently merged PR monitoring (from add-ai-docs)

All changes preserved from both branches.
@splat-sdlc-agent splat-sdlc-agent Bot merged commit 129158f into main May 12, 2026
@splat-sdlc-agent splat-sdlc-agent Bot deleted the add-ai-docs branch May 12, 2026 18:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant