Repository navigation
docs: ultra-minimal Starter base with root index - #9
Merged
Merged
Conversation
Keep main minimal; paper lives on release/paper branch. support_info/ excluded per owner request. Refs N/A - docs minimize setup.
…yment Mermaid (.mmd) canonical per Starter; Excalidraw never canonical. Validated flowchart syntax; mermaid-cli render on verify. Refs N/A - Starter arch baseline.
Auth/sensitive fires so threat-model required. data-model generator from storage/db.py + compat proof. ADR 0001 records 10-file decision. Refs N/A - Starter docs baseline.
Starter pointer-only; code canonical for schemas/contracts/config. Index links .mmd/data-model/threat-model/ADR only. No pastes. Refs N/A - ultra-minimal index.
Folded into root README; code canonical. runbook absent pre-prod. report.pdf stays on release. Refs N/A - ultra-minimal fold.
Real owner @G1DO + fallback; PR Closes/Refs trailers; private vuln route ack 2d/assess 7d/monthly. Refs N/A - Starter ownership.
verify.yml required gate; poe/make dev/test/migrate/build/contract/sast/secrets/audit/hygiene/diagrams/verify. Only stub+pasted-diagram custom checks. Fail-closed, absent omitted. Refs N/A - Starter CI.
Liveness cheap, readiness DB-checked 503. Single-line JSON stdout with traceparent/x-request-id, no secrets. Compose points to README ops. Refs N/A - Starter service standards.
Remove check_secrets, check_no_placeholders, check_no_pasted_diagrams, verify_schema_restore. Standard tools take over in the next commit. Refs N/A - standardize verify.
Exact mermaid fence from docs/architecture/README.md at 1be8cc6 under Architecture header, diagram only. Verify block uses gitleaks. Refs N/A - README index.
verify.yml/secrets.yml: pytest, diff-check, grep hygiene, pinned gitleaks, stdlib schema proof, npm lint/build. poe/make verbs, pre-push hook, PR template, doc refs updated to match. Refs N/A - standardize verify.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What changed: root README rewritten as pointer-run-verify-index; docs/ 24->9 (6x .mmd + data-model + threat-model + 1 ADR); removed obsolete companions + report.pdf (release asset); added CODEOWNERS/CONTRIBUTING/SECURITY private route; verify.yml sole gate + poe/make verbs + hygiene checks; health/ready split + JSON logging.
Why: follow Starter MUST/conditional + Template merge-over-add/absent-over-stub; one home per fact; main stays minimal, paper/release frozen.
Verification: check_no_placeholders ok; check_no_pasted_diagrams ok (no fences); check:secrets ok (157 files + history + gitleaks clean, pre-push); verify_schema_restore ok (30 tables, migrate 4 cols, restore 365 rows); git diff --check clean. pytest not run here (no pytest in system python) - run poe verify in CI.
8 small commits, no single big commit. support_info/ and paper/ excluded via .gitignore, not in PR.
Refs N/A - ultra-minimal docs + Starter base.