-
Notifications
You must be signed in to change notification settings - Fork 1
docs: core vs modules URL contract and OpenSpec alignment #448
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. Weβll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
273 changes: 5 additions & 268 deletions
273
docs/getting-started/tutorial-backlog-quickstart-demo.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,277 +1,14 @@ | ||
| --- | ||
| layout: default | ||
| title: Tutorial - Backlog Quickstart Demo (GitHub + ADO) | ||
| description: Short end-to-end demo for backlog init-config, map-fields, daily, and refine on GitHub and Azure DevOps. | ||
| description: Handoff to the backlog quickstart demo tutorial on the modules documentation site. | ||
| permalink: /getting-started/tutorial-backlog-quickstart-demo/ | ||
| --- | ||
|
|
||
| # Tutorial: Backlog Quickstart Demo (GitHub + ADO) | ||
| # Tutorial β backlog quickstart demo | ||
|
|
||
| A short end-to-end demo for backlog init, field mapping, daily flow, and refinement on GitHub and Azure DevOps. Copy-paste steps, screenshots, and troubleshooting are kept current on the modules site. | ||
|
djm81 marked this conversation as resolved.
|
||
|
|
||
| > 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/`. | ||
| **Prerequisites:** Accounts and tokens for your tracker; [Installation](https://docs.specfact.io/getting-started/installation/) completed. | ||
|
|
||
| This is a short, copy/paste-friendly demo for new users covering: | ||
|
|
||
| 1. `specfact backlog init-config` | ||
| 2. `specfact backlog map-fields` | ||
| 3. `specfact backlog daily` | ||
| 4. `specfact backlog refine` (GitHub + ADO) | ||
|
|
||
| It also includes a minimal create/check loop using `specfact backlog add`. | ||
|
|
||
| Preferred ceremony aliases: | ||
|
|
||
| - `specfact backlog ceremony standup` (same behavior as `backlog daily`) | ||
| - `specfact backlog ceremony refinement` (same behavior as `backlog refine`) | ||
|
|
||
| ## Targets Used in This Demo | ||
|
|
||
| - **GitHub**: `nold-ai/specfact-demo-repo` | ||
| - **Azure DevOps**: `dominikusnold/Specfact CLI` | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| - SpecFact CLI installed | ||
| - Auth configured: | ||
|
|
||
| ```bash | ||
| specfact backlog auth github | ||
| specfact backlog auth azure-devops | ||
| specfact backlog auth status | ||
| ``` | ||
|
|
||
| Expected status should show both providers as valid. | ||
|
|
||
| ## 1) Initialize Backlog Config | ||
|
|
||
| ```bash | ||
| specfact backlog init-config --force | ||
| ``` | ||
|
|
||
| This creates `.specfact/backlog-config.yaml`. | ||
|
|
||
| ## 2) Map Fields (ADO) | ||
|
|
||
| Run field mapping for your ADO project. Start with automatic mapping and use interactive mode only if required fields remain unresolved. | ||
|
|
||
| ```bash | ||
| # Automatic mapping for repeatable setup | ||
| specfact backlog map-fields \ | ||
| --provider ado \ | ||
| --ado-org dominikusnold \ | ||
| --ado-project "Specfact CLI" \ | ||
| --ado-framework scrum \ | ||
| --non-interactive | ||
|
|
||
| # Interactive mapping / manual correction | ||
| specfact backlog map-fields \ | ||
| --provider ado \ | ||
| --ado-org dominikusnold \ | ||
| --ado-project "Specfact CLI" \ | ||
| --ado-framework scrum | ||
| ``` | ||
|
|
||
| Notes: | ||
|
|
||
| - Select the process style intentionally (`--ado-framework scrum|agile|safe|kanban|default`). | ||
| - Mapping is written to `.specfact/templates/backlog/field_mappings/ado_custom.yaml`. | ||
| - Required fields, selected work item type, and constrained values are persisted in `.specfact/backlog-config.yaml`. | ||
| - `--non-interactive` fails fast with guidance to rerun interactive mapping if required fields remain unresolved. | ||
|
|
||
| Optional reset: | ||
|
|
||
| ```bash | ||
| specfact backlog map-fields \ | ||
| --provider ado \ | ||
| --ado-org dominikusnold \ | ||
| --ado-project "Specfact CLI" \ | ||
| --ado-framework scrum \ | ||
| --reset | ||
| ``` | ||
|
|
||
| ## 3) Daily Standup View (Check Backlog Read) | ||
|
|
||
| GitHub: | ||
|
|
||
| ```bash | ||
| specfact backlog daily github \ | ||
| --repo-owner nold-ai \ | ||
| --repo-name specfact-demo-repo \ | ||
| --state open \ | ||
| --limit 5 | ||
| ``` | ||
|
|
||
| Disable default state/assignee filters explicitly (for exact ID checks): | ||
|
|
||
| ```bash | ||
| specfact backlog daily github \ | ||
| --repo-owner nold-ai \ | ||
| --repo-name specfact-demo-repo \ | ||
| --id 28 \ | ||
| --state any \ | ||
| --assignee any | ||
| ``` | ||
|
|
||
| ADO: | ||
|
|
||
| ```bash | ||
| specfact backlog daily ado \ | ||
| --ado-org dominikusnold \ | ||
| --ado-project "Specfact CLI" \ | ||
| --limit 5 | ||
| ``` | ||
|
|
||
| ## 4) Refine Workflow (Preview + Tmp Export/Import) | ||
|
|
||
| GitHub export: | ||
|
|
||
| ```bash | ||
| specfact backlog refine github \ | ||
| --repo-owner nold-ai \ | ||
| --repo-name specfact-demo-repo \ | ||
| --limit 3 \ | ||
| --export-to-tmp | ||
| ``` | ||
|
|
||
| ADO export: | ||
|
|
||
| ```bash | ||
| specfact backlog refine ado \ | ||
| --ado-org dominikusnold \ | ||
| --ado-project "Specfact CLI" \ | ||
| --limit 3 \ | ||
| --export-to-tmp | ||
| ``` | ||
|
|
||
| After refining in your AI IDE, import and write back: | ||
|
|
||
| ```bash | ||
| # GitHub | ||
| specfact backlog refine github \ | ||
| --repo-owner nold-ai \ | ||
| --repo-name specfact-demo-repo \ | ||
| --import-from-tmp \ | ||
| --write | ||
|
|
||
| # ADO | ||
| specfact backlog refine ado \ | ||
| --ado-org dominikusnold \ | ||
| --ado-project "Specfact CLI" \ | ||
| --import-from-tmp \ | ||
| --write | ||
| ``` | ||
|
|
||
| ### Required Tmp File Contract (Important) | ||
|
|
||
| For `--import-from-tmp`, each item block must keep: | ||
|
|
||
| - `## Item N: <title>` | ||
| - `**ID**: <original-id>` (mandatory, unchanged) | ||
| - `**URL**`, `**State**`, `**Provider**` | ||
| - `**Body**:` fenced with ```markdown | ||
|
|
||
| Minimal scaffold: | ||
|
|
||
| ````markdown | ||
| ## Item 1: Example title | ||
|
|
||
| **ID**: 123 | ||
| **URL**: https://example | ||
| **State**: Active | ||
| **Provider**: ado | ||
|
|
||
| **Body**: | ||
| ```markdown | ||
| ## As a | ||
| ... | ||
| ``` | ||
| ```` | ||
|
|
||
| Do not rename labels and do not remove details during refinement. | ||
|
|
||
| ## 5) Minimal Create + Check Loop | ||
|
|
||
| Create test issue/work item: | ||
|
|
||
| ```bash | ||
| # GitHub create | ||
| specfact backlog add \ | ||
| --adapter github \ | ||
| --project-id nold-ai/specfact-demo-repo \ | ||
| --type story \ | ||
| --title "SpecFact demo smoke test $(date +%Y-%m-%d-%H%M)" \ | ||
| --body "Demo item created by quickstart." \ | ||
| --acceptance-criteria "Demo item exists and is retrievable" \ | ||
| --non-interactive | ||
|
|
||
| # ADO create | ||
| specfact backlog add \ | ||
| --adapter ado \ | ||
| --project-id "dominikusnold/Specfact CLI" \ | ||
| --type story \ | ||
| --title "SpecFact demo smoke test $(date +%Y-%m-%d-%H%M)" \ | ||
| --body "Demo item created by quickstart." \ | ||
| --acceptance-criteria "Demo item exists and is retrievable" \ | ||
| --custom-field category=Architecture \ | ||
| --custom-field subcategory="Runtime validation" \ | ||
| --non-interactive | ||
| ``` | ||
|
|
||
| Then verify retrieval by ID using `daily` or `refine --id <id>`. | ||
|
|
||
| For ADO projects with required custom fields or picklists: | ||
|
|
||
| - run `backlog map-fields` first so `backlog add` has required-field and allowed-values metadata | ||
| - use repeatable `--custom-field key=value` for mapped custom fields | ||
| - non-interactive `backlog add` rejects invalid picklist values before create and prints accepted values | ||
|
|
||
| ## Quick Troubleshooting | ||
|
|
||
| - DNS/network errors (`api.github.com`, `dev.azure.com`): verify outbound network access. | ||
| - Auth errors: re-run `specfact backlog auth status`. | ||
| - ADO mapping issues: re-run `backlog map-fields` and confirm `--ado-framework` is correct. Use interactive mode if auto-mapping cannot resolve required fields. | ||
| - Refine import mismatch: check `**ID**` was preserved exactly. | ||
|
|
||
| ## ADO Hardening Profile (Corporate Networks) | ||
|
|
||
| For unstable corporate VPN/proxy/firewall paths, use this reliability profile. | ||
|
|
||
| ### Runtime behavior now hardened in CLI | ||
|
|
||
| - ADO `daily`/`refine` read paths now retry transient transport failures (`ConnectionError`, reset/disconnect, timeout). | ||
| - Retry policy also covers retryable HTTP statuses (`429`, `500`, `502`, `503`, `504`) with backoff. | ||
| - Hardened paths include: | ||
| - WIQL query execution | ||
| - Work-item batch fetch | ||
| - Iteration/team lookup | ||
| - Work-item comments fetch | ||
|
|
||
| ### Operational command recommendations | ||
|
|
||
| Use explicit provider context and bounded scope to reduce query fragility: | ||
|
|
||
| ```bash | ||
| # Daily: explicit scope | ||
| specfact backlog daily ado \ | ||
| --ado-org dominikusnold \ | ||
| --ado-project "Specfact CLI" \ | ||
| --state New \ | ||
| --limit 20 | ||
|
|
||
| # Refine: small batches first, then scale | ||
| specfact backlog refine ado \ | ||
| --ado-org dominikusnold \ | ||
| --ado-project "Specfact CLI" \ | ||
| --state New \ | ||
| --limit 5 \ | ||
| --export-to-tmp | ||
| ``` | ||
|
|
||
| If current iteration auto-detection is unreliable in your environment, pass explicit filters (`--state`, `--sprint`, `--iteration`) rather than relying on defaults. | ||
|
|
||
| ### Create flow reliability notes | ||
|
|
||
| - `backlog add` uses safe no-replay behavior for create operations to avoid accidental duplicate work-item creation on ambiguous transport failures. | ||
| - If create returns an ambiguous transport error, check ADO for the title before retrying manually. | ||
| **Full tutorial on the canonical modules docs site:** [Backlog quickstart demo](https://modules.specfact.io/getting-started/tutorial-backlog-quickstart-demo/) | ||
|
djm81 marked this conversation as resolved.
|
||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.