save checkpoint: save features
This commit is contained in:
@@ -0,0 +1,33 @@
|
||||
# Developer Onboarding / Quick Start Documentation
|
||||
|
||||
## Module
|
||||
docs
|
||||
|
||||
## Status
|
||||
VERIFIED
|
||||
|
||||
## Description
|
||||
Quick start guide and development documentation exist covering setup, testing, architecture orientation, and local workflow entry points.
|
||||
|
||||
## Implementation Details
|
||||
- **Repo Documentation Index**: `docs/README.md` -- top-level entry point linking to setup, architecture, and standards docs.
|
||||
- **System Architecture**: `docs/07_HIGH_LEVEL_ARCHITECTURE.md` -- canonical high-level architecture overview.
|
||||
- **Platform Overview**: `docs/modules/platform/architecture-overview.md` -- platform architecture overview.
|
||||
- **Code of Conduct**: `docs/code-of-conduct/CODE_OF_CONDUCT.md` -- binding coding standards.
|
||||
- **Testing Practices**: `docs/code-of-conduct/TESTING_PRACTICES.md` -- testing standards and required layers.
|
||||
- **Module Dossiers**: `docs/modules/<module>/architecture*.md` -- module architecture references.
|
||||
- **DevPortal Site**: `src/DevPortal/StellaOps.DevPortal.Site/src/content/docs/guides/getting-started.mdx` -- onboarding quickstart guide.
|
||||
|
||||
## E2E Test Plan
|
||||
- [x] Verify `docs/README.md` references onboarding architecture and standards entry points.
|
||||
- [x] Verify local path references listed in `docs/README.md` resolve to existing targets.
|
||||
- [x] Verify DevPortal getting-started guide exists with actionable install/build-run guidance.
|
||||
- [x] Verify negative-path behavior for missing docs target detection returns non-zero status.
|
||||
|
||||
## Verification
|
||||
- Verified on 2026-02-11 via FLOW Tier 0/1/2 replay in `run-006`.
|
||||
- Tier 0: `docs/qa/feature-checks/runs/docs/developer-onboarding-quick-start-documentation/run-006/tier0-source-check.json`
|
||||
- Tier 1: `docs/qa/feature-checks/runs/docs/developer-onboarding-quick-start-documentation/run-006/tier1-build-check.json`
|
||||
- Tier 2: `docs/qa/feature-checks/runs/docs/developer-onboarding-quick-start-documentation/run-006/tier2-integration-check.json`
|
||||
- Triage/Fix: `docs/qa/feature-checks/runs/docs/developer-onboarding-quick-start-documentation/run-001/triage.json`, `docs/qa/feature-checks/runs/docs/developer-onboarding-quick-start-documentation/run-001/fix-summary.json`
|
||||
- Retest: `docs/qa/feature-checks/runs/docs/developer-onboarding-quick-start-documentation/run-006/retest-result.json`
|
||||
@@ -0,0 +1,31 @@
|
||||
# Implementor Guidelines Document
|
||||
|
||||
## Module
|
||||
docs
|
||||
|
||||
## Status
|
||||
VERIFIED
|
||||
|
||||
## Description
|
||||
The implementor guidelines document exists at the declared path covering operational checklists for code and doc changes.
|
||||
|
||||
## Implementation Details
|
||||
- **Code of Conduct**: `docs/code-of-conduct/CODE_OF_CONDUCT.md` -- binding coding standards for all implementers covering naming conventions, error handling patterns, commit discipline, and code review expectations.
|
||||
- **Testing Practices**: `docs/code-of-conduct/TESTING_PRACTICES.md` -- testing standards defining required test layers (unit, integration, E2E, performance, security), determinism requirements, and flakiness policies.
|
||||
- **Repo-Wide Agent Contract**: `CLAUDE.md` -- defines sprint file discipline, directory ownership, git safety rules, documentation sync requirements, dependency license gates, and role-based behavior contracts.
|
||||
- **Module-Local AGENTS.md**: Various `src/<module>/AGENTS.md` files -- per-module implementation guidelines that add module-specific rules without relaxing repo-wide standards.
|
||||
- **Sprint Template**: Defined in `CLAUDE.md` section 6 -- mandatory sprint file structure (Topic & Scope, Dependencies, Delivery Tracker, Execution Log, Decisions & Risks).
|
||||
|
||||
## E2E Test Plan
|
||||
- [x] Verify the `CODE_OF_CONDUCT.md` file exists and covers all sections referenced by the repo-wide agent contract (naming, error handling, commit discipline)
|
||||
- [x] Verify the `TESTING_PRACTICES.md` file exists and defines all required test layers (unit, integration, E2E, performance, security)
|
||||
- [x] Verify that at least 5 module directories under `src/` contain a module-local `AGENTS.md` file
|
||||
- [x] Verify the sprint template in `CLAUDE.md` section 6 is complete and includes all required sections
|
||||
- [x] Verify a new contributor can locate the implementor guidelines from the `docs/README.md` entry point within 2 navigation steps
|
||||
|
||||
## Verification
|
||||
- Verified on 2026-02-11 via FLOW Tier 0/1/2 replay in `run-002`.
|
||||
- Tier 0: `docs/qa/feature-checks/runs/docs/implementor-guidelines-document/run-002/tier0-source-check.json`
|
||||
- Tier 1: `docs/qa/feature-checks/runs/docs/implementor-guidelines-document/run-002/tier1-build-check.json`
|
||||
- Tier 2: `docs/qa/feature-checks/runs/docs/implementor-guidelines-document/run-002/tier2-integration-check.json`
|
||||
- Failure loop artifacts: `docs/qa/feature-checks/runs/docs/implementor-guidelines-document/run-001/triage.json`, `docs/qa/feature-checks/runs/docs/implementor-guidelines-document/run-001/confirmation.json`, `docs/qa/feature-checks/runs/docs/implementor-guidelines-document/run-001/fix-summary.json`, `docs/qa/feature-checks/runs/docs/implementor-guidelines-document/run-001/retest-result.json`
|
||||
Reference in New Issue
Block a user