Skip to content

docs: add team and enterprise guides#117

Merged
djm81 merged 2 commits intodevfrom
feature/docs-11-team-enterprise-tier
Mar 27, 2026
Merged

docs: add team and enterprise guides#117
djm81 merged 2 commits intodevfrom
feature/docs-11-team-enterprise-tier

Conversation

@djm81
Copy link
Copy Markdown
Contributor

@djm81 djm81 commented Mar 27, 2026

Summary

  • add a dedicated team-and-enterprise docs section with team collaboration, agile scrum setup, multi-repo, and enterprise config guides
  • split the docs-11 OpenSpec scope into team-setup-docs and enterprise-config-docs specs and record failing and passing evidence
  • extend the docs review suite to verify the new pages, bundle-owned resource language, and index navigation while keeping specfact code review run at 0 findings

Verification

  • python3 -m pytest tests/unit/docs/test_docs_review.py -q
  • bundle exec jekyll build --destination ../_site
  • specfact code review run tests/unit/docs/test_docs_review.py --no-tests
  • hatch run format
  • hatch run type-check
  • hatch run lint
  • hatch run yaml-lint
  • hatch run verify-modules-signature --require-signature --payload-from-filesystem --enforce-version-bump
  • hatch run contract-test
  • hatch run smart-test
  • hatch run test

@chatgpt-codex-connector
Copy link
Copy Markdown

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.
To continue using code reviews, you can upgrade your account or add credits to your account and enable them for code reviews in your settings.

@djm81 djm81 self-assigned this Mar 27, 2026
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 27, 2026

Caution

Review failed

Pull request was closed or merged during review

📝 Walkthrough

Summary by CodeRabbit

  • Documentation
    • Added "Team And Enterprise" section with four new guides: Team Collaboration Setup (team bootstrap and role workflows), Agile And Scrum Team Setup (operational playbook for Scrum/Kanban teams), Multi-Repo Setup (cross-repo workflows), and Enterprise Configuration (profiles, overlays, and multi-registry management).

Walkthrough

This PR adds comprehensive team and enterprise documentation, including four new setup guides covering team collaboration, Agile/Scrum workflows, multi-repository management, and enterprise configuration. The docs index is updated with navigation links, specifications are added for documentation requirements, and test coverage is extended with helper functions for front-matter parsing and internal link validation.

Changes

Cohort / File(s) Summary
Documentation Pages
docs/team-and-enterprise/team-collaboration.md, docs/team-and-enterprise/agile-scrum-setup.md, docs/team-and-enterprise/multi-repo.md, docs/team-and-enterprise/enterprise-config.md
Added four new documentation pages covering team collaboration setup, Agile/Scrum workflows, multi-repository configurations, and enterprise setup guidance with bootstrap commands, operational procedures, and role-based workflows.
Navigation and Index
docs/index.md
Added "Team And Enterprise" section with four navigational links to new team-and-enterprise subpages.
Specification Requirements
openspec/specs/team-setup-docs/spec.md, openspec/specs/enterprise-config-docs/spec.md
Added documentation specifications defining requirements for team setup guidance (onboarding, resource ownership, role workflows) and enterprise configuration coverage (profiles, overlays, multi-repo policy).
Test Work Change Specs
openspec/changes/docs-11-team-enterprise-tier/specs/team-setup-docs/spec.md, openspec/changes/docs-11-team-enterprise-tier/specs/enterprise-config-docs/spec.md
Added specifications for team-enterprise documentation tier work with requirement assertions for team setup and enterprise config topics.
Test Work Tracking
openspec/changes/docs-11-team-enterprise-tier/tasks.md, openspec/changes/docs-11-team-enterprise-tier/TDD_EVIDENCE.md
Marked all work tasks as completed and documented end-to-end verification artifacts including CLI help verification, link validation, Jekyll build confirmation, and test execution results.
Test Refactoring and Coverage
tests/unit/docs/test_docs_review.py
Refactored YAML front-matter parsing (_front_matter_end_index(), _extract_redirect_route()) and internal docs link resolution (_resolve_route_target(), _path_lookup_result(), _resolve_candidate_markdown_target(), _ignored_internal_link(), _resolve_http_docs_target(), _resolve_relative_docs_target()). Added new test assertions for team-and-enterprise page existence, content validation, and docs index navigation links.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~22 minutes

Possibly related issues

Possibly related PRs

Suggested labels

openspec, documentation, testing

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 5.88% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely summarizes the main change: addition of comprehensive team and enterprise guides to documentation.
Description check ✅ Passed The description covers the main objectives (team-and-enterprise docs section, OpenSpec scope split, docs review suite extension) and lists verification steps, but omits bundle impact details, CI job expectations, and several required local gates from the template.

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

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feature/docs-11-team-enterprise-tier

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

@djm81 djm81 added documentation Improvements or additions to documentation enhancement New feature or request labels Mar 27, 2026
@djm81 djm81 moved this from Todo to In Progress in SpecFact CLI Mar 27, 2026
@djm81 djm81 linked an issue Mar 27, 2026 that may be closed by this pull request
@djm81
Copy link
Copy Markdown
Contributor Author

djm81 commented Mar 27, 2026

@coderabbitai review

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 27, 2026

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@djm81
Copy link
Copy Markdown
Contributor Author

djm81 commented Mar 27, 2026

@coderabbitai your review failed (was not done!) due to rebase of branch, please run review.

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 27, 2026

@djm81 No problem! Triggering a fresh review now.


🧠 Learnings used
Learnt from: CR
Repo: nold-ai/specfact-cli-modules PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-03-25T21:31:11.712Z
Learning: Follow strict TDD order: spec delta -> failing tests -> implementation -> passing tests -> quality gates. Record TDD evidence in `openspec/changes/<change-id>/TDD_EVIDENCE.md`

Learnt from: CR
Repo: nold-ai/specfact-cli-modules PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-03-26T23:11:11.388Z
Learning: Applies to openspec/changes/*/TDD_EVIDENCE.md : Record failing/passing test evidence in openspec/changes/<change-id>/TDD_EVIDENCE.md

Learnt from: CR
Repo: nold-ai/specfact-cli-modules PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-03-26T23:11:11.388Z
Learning: Before changing code, verify an active OpenSpec change explicitly covers the requested scope; follow strict TDD order: spec delta → failing tests → implementation → passing tests → quality gates
✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@djm81
Copy link
Copy Markdown
Contributor Author

djm81 commented Mar 27, 2026

@coderabbitai review again after we hit rate limit

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 27, 2026

@djm81 No problem! Triggering another review now.


🧠 Learnings used
Learnt from: CR
Repo: nold-ai/specfact-cli-modules PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-03-25T21:31:11.712Z
Learning: Follow strict TDD order: spec delta -> failing tests -> implementation -> passing tests -> quality gates. Record TDD evidence in `openspec/changes/<change-id>/TDD_EVIDENCE.md`

Learnt from: CR
Repo: nold-ai/specfact-cli-modules PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-03-26T23:11:11.388Z
Learning: Before changing code, verify an active OpenSpec change explicitly covers the requested scope; follow strict TDD order: spec delta → failing tests → implementation → passing tests → quality gates

Learnt from: CR
Repo: nold-ai/specfact-cli-modules PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-03-26T23:11:11.388Z
Learning: Applies to openspec/changes/*/TDD_EVIDENCE.md : Record failing/passing test evidence in openspec/changes/<change-id>/TDD_EVIDENCE.md
✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@djm81 djm81 merged commit 773e512 into dev Mar 27, 2026
10 checks passed
@github-project-automation github-project-automation bot moved this from In Progress to Done in SpecFact CLI Mar 27, 2026
@coderabbitai coderabbitai bot mentioned this pull request Mar 28, 2026
29 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

docs-11: Create Team And Enterprise Documentation Tier

1 participant