Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 19 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,19 @@

---

## Documentation Topology

`docs.specfact.io` is the canonical docs entry point for SpecFact.

- Core CLI/runtime/platform documentation remains owned by `specfact-cli`.
- Module-specific deep docs are canonically owned by `specfact-cli-modules`.
- The live modules docs site is currently published at `https://modules.specfact.io/`.

Use this repository's docs for core runtime, lifecycle, registry, trust, and architecture guidance. Use the modules docs site for bundle-specific workflow and module-authoring deep dives.
In short, module-specific deep docs are canonically owned by `specfact-cli-modules`.

---

## Start Here (60 seconds)

### Install
Expand Down Expand Up @@ -205,9 +218,10 @@ For technical architecture details (module lifecycle, registry internals, adapte

SpecFact ships official bundle packages via the dedicated marketplace registry repository
`nold-ai/specfact-cli-modules`.
Bundle-specific docs are still temporarily hosted in this docs set while the long-term
bundle docs home is prepared in the modules repository docs site:
`https://nold-ai.github.io/specfact-cli-modules/`.

This core docs set remains the canonical docs entry point and release-line overview for marketplace concepts.
Bundle-specific deep docs are canonically owned by `specfact-cli-modules` and are currently published at:
`https://modules.specfact.io/`.

Install examples:

Expand All @@ -232,9 +246,8 @@ auto-install dependencies:
- `nold-ai/specfact-spec` pulls `nold-ai/specfact-project`
- `nold-ai/specfact-govern` pulls `nold-ai/specfact-project`

Use this repo's docs for the current CLI/runtime release branch. Module-specific guides
will move to `specfact-cli-modules` so future bundle-only changes do not require ongoing
docs maintenance in long-lived `specfact-cli` release branches.
Use this repo's docs for the current CLI/runtime release branch and for marketplace lifecycle overview content.
Use the modules docs site for bundle-specific deep guidance so bundle-only changes can ship without rebuilding the core docs release branch.

---

Expand Down
17 changes: 14 additions & 3 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
---
layout: default
title: Documentation Index
permalink: /documentation-index/
description: High-level index for the SpecFact CLI documentation sections and guides.
---

# SpecFact CLI Documentation

> **The "swiss knife" CLI that turns any codebase into a clear, safe, and shippable workflow.**
Expand Down Expand Up @@ -84,16 +91,20 @@ SpecFact CLI uses a lifecycle-managed module system:

This is the baseline for marketplace-driven module lifecycle and future community module distribution.

Module-specific guides are still temporarily hosted in this docs set while the long-term
bundle docs home is prepared in `nold-ai/specfact-cli-modules`.
`docs.specfact.io` is the canonical docs entry point for SpecFact, and this repository owns the
core CLI/runtime section of that experience.

The canonical modules docs site is currently published at
`https://modules.specfact.io/`.
Bundle-specific deep guides in this repo remain as release-line overview or handoff content rather than the long-term canonical source.

### Why the Module System Is the Foundation

This architecture intentionally separates the CLI core from feature modules:

- Core provides lifecycle, registry, contracts, and orchestration.
- Official workflow bundles are authored and released from `nold-ai/specfact-cli-modules`.
- This docs set still hosts bundle-specific guidance temporarily for the `0.40.x` release line.
- This docs set keeps release-line overview and handoff content for bundle workflows while the canonical modules docs site carries the deep bundle-specific guidance.
- Compatibility shims preserve legacy import paths during migration windows.

Practical outcomes:
Expand Down
7 changes: 3 additions & 4 deletions docs/_layouts/default.html
Original file line number Diff line number Diff line change
Expand Up @@ -111,10 +111,9 @@
</span>
</label>
<div class="trigger">
<a class="page-link" href="{{ '/' | relative_url }}">Home</a>
<a class="page-link" href="{{ '/getting-started/installation/' | relative_url }}">Getting Started</a>
<a class="page-link" href="{{ '/guides/command-chains/' | relative_url }}">Guides</a>
<a class="page-link" href="{{ '/reference/' | relative_url }}">Reference</a>
<a class="page-link" href="https://docs.specfact.io/">Docs Home</a>
<a class="page-link" href="{{ '/' | relative_url }}">Core CLI</a>
<a class="page-link" href="https://modules.specfact.io/">Modules</a>
</div>
</nav>
</div>
Expand Down
5 changes: 3 additions & 2 deletions docs/adapters/azuredevops.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,9 @@ permalink: /adapters/azuredevops/
# Azure DevOps Adapter


> Temporary docs note: this bundle-focused page remains hosted in the core docs set for the
> current release line and is planned to migrate to `specfact-cli-modules`.
> Modules docs handoff: this page remains in the core docs set as release-line overview content.
> Canonical bundle-specific deep guidance now lives in the canonical modules docs site, currently
> published at `https://modules.specfact.io/`.

The Azure DevOps adapter provides bidirectional synchronization between OpenSpec change proposals and Azure DevOps work items, enabling agile DevOps-driven workflow support for enterprise teams.

Expand Down
5 changes: 3 additions & 2 deletions docs/adapters/github.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,9 @@ permalink: /adapters/github/
# GitHub Adapter


> Temporary docs note: this bundle-focused page remains hosted in the core docs set for the
> current release line and is planned to migrate to `specfact-cli-modules`.
> Modules docs handoff: this page remains in the core docs set as release-line overview content.
> Canonical bundle-specific deep guidance now lives in the canonical modules docs site, currently
> published at `https://modules.specfact.io/`.

The GitHub adapter provides bidirectional synchronization between OpenSpec change proposals and GitHub Issues, enabling agile DevOps-driven workflow support.

Expand Down
5 changes: 3 additions & 2 deletions docs/getting-started/tutorial-backlog-quickstart-demo.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,9 @@ permalink: /getting-started/tutorial-backlog-quickstart-demo/
# Tutorial: Backlog Quickstart Demo (GitHub + ADO)


> Temporary docs note: this bundle-focused page remains hosted in the core docs set for the
> current release line and is planned to migrate to `specfact-cli-modules`.
> Modules docs handoff: this page remains in the core docs set as release-line overview content.
> Canonical bundle-specific deep guidance now lives in the canonical modules docs site, currently
> published at `https://modules.specfact.io/`.

This is a short, copy/paste-friendly demo for new users covering:

Expand Down
5 changes: 3 additions & 2 deletions docs/getting-started/tutorial-backlog-refine-ai-ide.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,9 @@ permalink: /getting-started/tutorial-backlog-refine-ai-ide/
# Tutorial: Backlog Refine with Your AI IDE (Agile DevOps Teams)


> Temporary docs note: this bundle-focused page remains hosted in the core docs set for the
> current release line and is planned to migrate to `specfact-cli-modules`.
> Modules docs handoff: this page remains in the core docs set as release-line overview content.
> Canonical bundle-specific deep guidance now lives in the canonical modules docs site, currently
> published at `https://modules.specfact.io/`.

This tutorial walks agile DevOps teams through integrating SpecFact CLI backlog refinement with their AI IDE (Cursor, VS Code + Copilot, Claude Code, etc.) using the interactive slash prompt. You will improve backlog story quality, make informed decisions about underspecification, split stories when too big, fix ambiguities, respect Definition of Ready (DoR), and optionally use custom template mapping for advanced teams.

Expand Down
5 changes: 3 additions & 2 deletions docs/getting-started/tutorial-daily-standup-sprint-review.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,9 @@ permalink: /getting-started/tutorial-daily-standup-sprint-review/
# Tutorial: Daily Standup and Sprint Review with SpecFact CLI


> Temporary docs note: this bundle-focused page remains hosted in the core docs set for the
> current release line and is planned to migrate to `specfact-cli-modules`.
> Modules docs handoff: this page remains in the core docs set as release-line overview content.
> Canonical bundle-specific deep guidance now lives in the canonical modules docs site, currently
> published at `https://modules.specfact.io/`.

This tutorial walks you through a complete **daily standup and sprint review** workflow using SpecFact CLI: view your backlog items, optionally post standup comments to issues, use interactive step-through and Copilot export—with **no need to pass org/repo or org/project** when you run from your cloned repo.

Expand Down
5 changes: 3 additions & 2 deletions docs/guides/agile-scrum-workflows.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,9 @@ permalink: /guides/agile-scrum-workflows/
# Agile/Scrum Workflows with SpecFact CLI


> Temporary docs note: this bundle-focused page remains hosted in the core docs set for the
> current release line and is planned to migrate to `specfact-cli-modules`.
> Modules docs handoff: this page remains in the core docs set as release-line overview content.
> Canonical bundle-specific deep guidance now lives in the canonical modules docs site, currently
> published at `https://modules.specfact.io/`.

This guide explains how to use SpecFact CLI for agile/scrum workflows, including backlog management, sprint planning, dependency tracking, and Definition of Ready (DoR) validation.

Expand Down
5 changes: 3 additions & 2 deletions docs/guides/backlog-delta-commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,9 @@ permalink: /guides/backlog-delta-commands/
# Backlog Delta Commands


> Temporary docs note: this bundle-focused page remains hosted in the core docs set for the
> current release line and is planned to migrate to `specfact-cli-modules`.
> Modules docs handoff: this page remains in the core docs set as release-line overview content.
> Canonical bundle-specific deep guidance now lives in the canonical modules docs site, currently
> published at `https://modules.specfact.io/`.

`delta` commands are grouped under backlog because they describe backlog graph drift and impact, not source-code diffs.

Expand Down
5 changes: 3 additions & 2 deletions docs/guides/backlog-dependency-analysis.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,9 @@ permalink: /guides/backlog-dependency-analysis/
# Backlog Dependency Analysis


> Temporary docs note: this bundle-focused page remains hosted in the core docs set for the
> current release line and is planned to migrate to `specfact-cli-modules`.
> Modules docs handoff: this page remains in the core docs set as release-line overview content.
> Canonical bundle-specific deep guidance now lives in the canonical modules docs site, currently
> published at `https://modules.specfact.io/`.

Use SpecFact to build a provider-agnostic dependency graph from backlog tools and analyze execution risk before delivery.

Expand Down
5 changes: 3 additions & 2 deletions docs/guides/backlog-refinement.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,9 @@ permalink: /guides/backlog-refinement/
# Backlog Refinement Guide


> Temporary docs note: this bundle-focused page remains hosted in the core docs set for the
> current release line and is planned to migrate to `specfact-cli-modules`.
> Modules docs handoff: this page remains in the core docs set as release-line overview content.
> Canonical bundle-specific deep guidance now lives in the canonical modules docs site, currently
> published at `https://modules.specfact.io/`.

> **🆕 NEW FEATURE: AI-Assisted Template-Driven Backlog Refinement**
> Transform arbitrary DevOps backlog input into structured, template-compliant work items using AI-assisted refinement with template detection and validation.
Expand Down
12 changes: 10 additions & 2 deletions docs/guides/contract-testing-workflow.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,16 @@
---
layout: default
title: Contract Testing Workflow
permalink: /guides/contract-testing-workflow/
description: Practical contract testing workflow guidance for SpecFact users and developers.
---

# Contract Testing Workflow - Simple Guide for Developers


> Temporary docs note: this bundle-focused page remains hosted in the core docs set for the
> current release line and is planned to migrate to `specfact-cli-modules`.
> Modules docs handoff: this page remains in the core docs set as release-line overview content.
> Canonical bundle-specific deep guidance now lives in the canonical modules docs site, currently
> published at `https://modules.specfact.io/`.

## Quick Start: Verify Your Contract

Expand Down
5 changes: 3 additions & 2 deletions docs/guides/custom-field-mapping.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,9 @@ permalink: /guides/custom-field-mapping/
# Custom Field Mapping Guide


> Temporary docs note: this bundle-focused page remains hosted in the core docs set for the
> current release line and is planned to migrate to `specfact-cli-modules`.
> Modules docs handoff: this page remains in the core docs set as release-line overview content.
> Canonical bundle-specific deep guidance now lives in the canonical modules docs site, currently
> published at `https://modules.specfact.io/`.

> **Customize ADO field mappings** for your specific Azure DevOps process templates and agile frameworks.

Expand Down
5 changes: 3 additions & 2 deletions docs/guides/devops-adapter-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,9 @@ permalink: /guides/devops-adapter-integration/
# DevOps Adapter Integration Guide


> Temporary docs note: this bundle-focused page remains hosted in the core docs set for the
> current release line and is planned to migrate to `specfact-cli-modules`.
> Modules docs handoff: this page remains in the core docs set as release-line overview content.
> Canonical bundle-specific deep guidance now lives in the canonical modules docs site, currently
> published at `https://modules.specfact.io/`.

> **🆕 NEW FEATURE: Integrate SpecFact into Agile DevOps Workflows**
> Bidirectional synchronization between OpenSpec change proposals and DevOps backlog tools enables seamless integration of specification-driven development into your existing agile workflows.
Expand Down
12 changes: 10 additions & 2 deletions docs/guides/dual-stack-enrichment.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,16 @@
---
layout: default
title: Dual-Stack Enrichment Pattern
permalink: /guides/dual-stack-enrichment/
description: Guidance for combining SpecFact CLI automation with AI IDE enrichment workflows.
---

# Dual-Stack Enrichment Pattern


> Temporary docs note: this bundle-focused page remains hosted in the core docs set for the
> current release line and is planned to migrate to `specfact-cli-modules`.
> Modules docs handoff: this page remains in the core docs set as release-line overview content.
> Canonical bundle-specific deep guidance now lives in the canonical modules docs site, currently
> published at `https://modules.specfact.io/`.

**Status**: ✅ **AVAILABLE** (v0.13.0+)
**Last Updated**: 2025-12-23
Expand Down
5 changes: 3 additions & 2 deletions docs/guides/import-features.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,9 @@ permalink: /guides/import-features/
# Import Command Features


> Temporary docs note: this bundle-focused page remains hosted in the core docs set for the
> current release line and is planned to migrate to `specfact-cli-modules`.
> Modules docs handoff: this page remains in the core docs set as release-line overview content.
> Canonical bundle-specific deep guidance now lives in the canonical modules docs site, currently
> published at `https://modules.specfact.io/`.

This guide covers advanced features and optimizations in the `import from-code` command.

Expand Down
5 changes: 4 additions & 1 deletion docs/guides/installing-modules.md
Original file line number Diff line number Diff line change
Expand Up @@ -180,5 +180,8 @@ specfact module upgrade --all

Upgrade applies only to modules with origin `marketplace`.

> Temporary docs note: module-specific install and bundle behavior docs remain hosted in this
> Modules docs handoff: this page remains in the core docs set as release-line overview content.
> Canonical bundle-specific deep guidance now lives in the canonical modules docs site, currently
> published at `https://modules.specfact.io/`.

> core docs set for the current release line and are planned to migrate to `specfact-cli-modules`.
5 changes: 3 additions & 2 deletions docs/guides/marketplace.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,5 +82,6 @@ specfact module init
- [Installing Modules](installing-modules.md)
- [Module Categories](../reference/module-categories.md)

> Temporary docs note: bundle-specific marketplace guidance remains hosted in this core docs set
> for the current release line and is planned to migrate to `specfact-cli-modules`.
> Modules docs handoff: this page remains in the core docs set as release-line overview content.
> Canonical bundle-specific deep guidance now lives in the canonical modules docs site, currently
> published at `https://modules.specfact.io/`.
5 changes: 3 additions & 2 deletions docs/guides/module-development.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,9 @@ description: How to build and package SpecFact CLI modules.

This guide defines the required structure and contracts for authoring SpecFact modules.

> Temporary docs note: module-authoring guidance is still hosted in this core docs set for the
> current release line and is planned to migrate to `specfact-cli-modules`.
> Modules docs handoff: this page remains in the core docs set as release-line overview content.
> Canonical bundle-specific deep guidance now lives in the canonical modules docs site, currently
> published at `https://modules.specfact.io/`.

Official workflow bundle implementation now lives in the dedicated `nold-ai/specfact-cli-modules`
repository. `specfact-cli` owns the lean runtime, registry, marketplace lifecycle, shared
Expand Down
5 changes: 4 additions & 1 deletion docs/guides/module-marketplace.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,5 +115,8 @@ Scope boundary:
- Full command tree, including subcommands
- Short command descriptions derived from Typer command registration

> Temporary docs note: marketplace and bundle-specific docs remain hosted in this core docs set
> Modules docs handoff: this page remains in the core docs set as release-line overview content.
> Canonical bundle-specific deep guidance now lives in the canonical modules docs site, currently
> published at `https://modules.specfact.io/`.

> for the current release line and are planned to migrate to `specfact-cli-modules`.
5 changes: 3 additions & 2 deletions docs/guides/module-signing-and-key-rotation.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,9 @@ description: Runbook for signing official workflow bundles, placing public keys,

This runbook defines the repeatable process for signing official workflow bundles and verifying signatures in SpecFact CLI.

> Temporary docs note: module signing guidance is still hosted in this core docs set for the
> current release line and is planned to migrate to `specfact-cli-modules`.
> Modules docs handoff: this page remains in the core docs set as release-line overview content.
> Canonical bundle-specific deep guidance now lives in the canonical modules docs site, currently
> published at `https://modules.specfact.io/`.

## Key Placement

Expand Down
5 changes: 3 additions & 2 deletions docs/guides/policy-engine-commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,9 @@ permalink: /guides/policy-engine-commands/
# Policy Engine Commands


> Temporary docs note: this bundle-focused page remains hosted in the core docs set for the
> current release line and is planned to migrate to `specfact-cli-modules`.
> Modules docs handoff: this page remains in the core docs set as release-line overview content.
> Canonical bundle-specific deep guidance now lives in the canonical modules docs site, currently
> published at `https://modules.specfact.io/`.

Use SpecFact policy commands to scaffold, validate, and improve policy configuration for common frameworks.

Expand Down
5 changes: 3 additions & 2 deletions docs/guides/project-devops-flow.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,9 @@ permalink: /guides/project-devops-flow/
# Project DevOps Flow


> Temporary docs note: this bundle-focused page remains hosted in the core docs set for the
> current release line and is planned to migrate to `specfact-cli-modules`.
> Modules docs handoff: this page remains in the core docs set as release-line overview content.
> Canonical bundle-specific deep guidance now lives in the canonical modules docs site, currently
> published at `https://modules.specfact.io/`.

Use `specfact project devops-flow` to run an integrated lifecycle against a linked backlog provider.

Expand Down
5 changes: 3 additions & 2 deletions docs/guides/publishing-modules.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,9 @@ description: Package and publish SpecFact modules to a registry (tarball, checks

This guide describes how to package a SpecFact module for registry publishing: validate structure, create a tarball and checksum, optionally sign the manifest, and automate publishing in the dedicated modules repository.

> Temporary docs note: module publishing guidance is still hosted in this core docs set for the
> current release line and is planned to migrate to `specfact-cli-modules`.
> Modules docs handoff: this page remains in the core docs set as release-line overview content.
> Canonical bundle-specific deep guidance now lives in the canonical modules docs site, currently
> published at `https://modules.specfact.io/`.

## Repository ownership

Expand Down
5 changes: 3 additions & 2 deletions docs/guides/sidecar-validation.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,9 @@ permalink: /guides/sidecar-validation/
# Sidecar Validation Guide


> Temporary docs note: this bundle-focused page remains hosted in the core docs set for the
> current release line and is planned to migrate to `specfact-cli-modules`.
> Modules docs handoff: this page remains in the core docs set as release-line overview content.
> Canonical bundle-specific deep guidance now lives in the canonical modules docs site, currently
> published at `https://modules.specfact.io/`.

Complete guide for using sidecar validation to validate external codebases without modifying source code.

Expand Down
Loading
Loading