2.2 KiB
2.2 KiB
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
- Verify
docs/README.mdreferences onboarding architecture and standards entry points. - Verify local path references listed in
docs/README.mdresolve to existing targets. - Verify DevPortal getting-started guide exists with actionable install/build-run guidance.
- 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