semi implemented and features implemented save checkpoint

This commit is contained in:
master
2026-02-08 18:00:49 +02:00
parent 04360dff63
commit 1bf6bbf395
20895 changed files with 716795 additions and 64 deletions

View File

@@ -0,0 +1,26 @@
# Developer Onboarding / Quick Start Documentation
## Module
docs
## Status
IMPLEMENTED
## Description
Quick start guide and development documentation exist covering setup, testing, and local CI workflows.
## Implementation Details
- **Repo Documentation Index**: `docs/README.md` -- top-level entry point linking to all documentation areas including setup, architecture, and module dossiers.
- **System Architecture**: `docs/07_HIGH_LEVEL_ARCHITECTURE.md` -- high-level architecture overview for new developers.
- **Platform Overview**: `docs/modules/platform/architecture-overview.md` -- platform architecture overview covering module interactions and deployment topology.
- **Code of Conduct**: `docs/code-of-conduct/CODE_OF_CONDUCT.md` -- binding coding standards for all implementers.
- **Testing Practices**: `docs/code-of-conduct/TESTING_PRACTICES.md` -- testing standards and practices for QA and developers.
- **Module Dossiers**: `docs/modules/<module>/architecture.md` -- per-module architecture documentation with contracts, schemas, and API surface.
- **DevPortal Site**: `src/DevPortal/StellaOps.DevPortal.Site/src/content/docs/guides/getting-started.mdx` -- SDK quickstart guide with code examples and setup instructions.
## E2E Test Plan
- [ ] Follow the quick start guide from scratch on a clean machine and verify all setup steps complete successfully (clone, install dependencies, build, run tests)
- [ ] Verify the `docs/README.md` index page links to all active documentation sections and none return 404
- [ ] Verify the DevPortal getting-started guide renders correctly and code examples are syntactically valid
- [ ] Verify the architecture overview document is consistent with the current module layout under `src/`
- [ ] Verify a new contributor can find the testing practices document from the README and understand the test layer requirements

View File

@@ -0,0 +1,24 @@
# Implementor Guidelines Document
## Module
docs
## Status
IMPLEMENTED
## 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
- [ ] Verify the `CODE_OF_CONDUCT.md` file exists and covers all sections referenced by the repo-wide agent contract (naming, error handling, commit discipline)
- [ ] Verify the `TESTING_PRACTICES.md` file exists and defines all required test layers (unit, integration, E2E, performance, security)
- [ ] Verify that at least 5 module directories under `src/` contain a module-local `AGENTS.md` file
- [ ] Verify the sprint template in `CLAUDE.md` section 6 is complete and includes all required sections
- [ ] Verify a new contributor can locate the implementor guidelines from the `docs/README.md` entry point within 2 navigation steps