Skip to content

OPS-POLISH-001: Polish public repository status docs#654

Merged
ktalpay merged 2 commits into
developfrom
codex/polish-carbonops-parser-documentation
Jun 18, 2026
Merged

OPS-POLISH-001: Polish public repository status docs#654
ktalpay merged 2 commits into
developfrom
codex/polish-carbonops-parser-documentation

Conversation

@ktalpay

@ktalpay ktalpay commented Jun 18, 2026

Copy link
Copy Markdown
Owner

Motivation

  • Remove stale "baseline/planned" wording and align public docs with the current develop-state evidence for a narrow project-level production-ready operator path.
  • Improve first-impression navigation, conservative status language, and contributor/maintainer runbook guidance without changing runtime code or behavior.
  • Add an explicit maintainer release/sync checklist to guide develop-to-main sync, hygiene, and first alpha/review readiness.

Description

  • Updated README to present a narrow production-ready operator path, clarify active Python runtime and .NET parity evidence, add explicit non-claims, and improve Start Here navigation and database/runbook links; no runtime/code changes were made (README.md).
  • Reworked documentation index for clearer visitor flows (Start Here, runtime runbooks, DB/PostgreSQL, Phase 2/review gate, contribution/support/security) (docs/index.md).
  • Added a maintainer release and sync checklist (docs/maintainer-release-checklist.md) covering develop-to-main alignment, stale PR/issue review, release/tag readiness, and repository hygiene.
  • Replaced stale/planning wording in several supporting docs to reflect the active Phase 1 posture and .NET parity evidence and to use conservative terminology without expanding claims (docs/engineering-standards.md, docs/ingestion-metadata-model.md, docs/limitations.md, docs/production-readiness-gap-analysis.md, docs/roadmap.md, docs/source-acquisition-boundary.md, docs/source-ingestion-boundaries.md, docs/task-breakdown.md).
  • No Python/.NET/runtime/database code, schema, or dependencies were changed and no secrets or generated artifacts were added.

Testing

  • Local Markdown link consistency check (python - <<'PY' ... PY) passed and confirmed all changed-doc local links resolve.
  • Stale-phrase grep check (rg -n "early Phase 1|documentation baseline|CI not configured yet|Python planned|\.NET planned|implementation begins" README.md) returned no matches, so README stale phrase check passed.
  • git diff --check ran and passed with no whitespace/patch errors.
  • Targeted unit test run (python -m pytest tests/test_configured_cycle_runner.py) passed: 21 tests passed in ~1.1s.
  • git status --short was inspected and temporary __pycache__ files were removed before committing; committed change set contains only intended docs changes (commit created with message: "Polish public project status docs").

Codex Task

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 98bb792756

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

## .NET Production Readiness Gaps

The .NET path is currently a planned implementation option rather than a parity implementation.
The .NET path now has parity evidence for the reviewed production scope; remaining gaps should be tracked as explicit parity or runtime-promotion review items.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Remove stale .NET gap text

When readers use this gap analysis after the status-doc refresh, this new parity-evidence sentence conflicts with the same section's remaining gap list and closing sentence, which still say the .NET path needs project structure/runtime entry points and that parity should begin later. That makes the public readiness guidance internally inconsistent, so the stale .NET gap text should be reconciled with the new claimed parity scope.

Useful? React with 👍 / 👎.

@ktalpay
ktalpay merged commit 5bb6ab9 into develop Jun 18, 2026
1 check passed
@ktalpay
ktalpay deleted the codex/polish-carbonops-parser-documentation branch June 18, 2026 08:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant