Rewrite README as enterprise showcase#65
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
Code Review
This pull request significantly restructures the README to focus on a cloud-first validation architecture and an industrial prototype positioning. Key changes include the addition of a Vercel showcase link, new sections on architecture highlights and enterprise positioning, and updated maintainer commands. Review feedback highlighted a branding inconsistency with the repository style guide regarding the project name casing, discrepancies in documentation regarding report storage locations and directory naming for 'hash-companion' docs, and a request for clarification on the new dashboard execution flag.
| @@ -1,208 +1,244 @@ | |||
| # CompText V7 — KVTC Cognitive Fabric for Technical Logs | |||
| # Comptextv7 — Cloud-First Diagnostic Compression Infrastructure | |||
There was a problem hiding this comment.
The project name has been changed to Comptextv7, but the Repository Style Guide (Project Memory) consistently uses CompText V7 (see lines 1, 4, 7, and 13 of the style guide). To maintain branding consistency and adhere to the project's established identity, the name should remain CompText V7 unless a formal renaming is intended across all documentation and the style guide.
| # Comptextv7 — Cloud-First Diagnostic Compression Infrastructure | |
| # CompText V7 — Cloud-First Diagnostic Compression Infrastructure |
References
- The style guide defines the project as 'CompText V7' and uses this casing throughout the mission and architectural pillars. (link)
| ├── contracts/ # machine-readable handoff contracts | ||
| ├── dashboard/ # backend plus React operations console | ||
| ├── datasets/golden/ # immutable synthetic replay fixtures | ||
| ├── docs/ # showcase, reports, wiki, and Hash/chilli docs |
There was a problem hiding this comment.
The repository map refers to Hash/chilli docs, but the links in the 'CFI artifact model' table (lines 125-126) point to the docs/hash-companion/ directory. These should be aligned to ensure the documentation is easy to navigate and consistent with the actual file structure.
| ├── docs/ # showcase, reports, wiki, and Hash/chilli docs | |
| ├── docs/ # showcase, reports, wiki, and hash-companion docs |
| 1. Open the [live Vercel showcase](https://comptextv7.vercel.app). | ||
| 2. Read the [demo walkthrough](docs/DEMO_WALKTHROUGH.md) for the no-local-execution path. | ||
| 3. Check the latest GitHub Actions runs for `ci.yml`, `agent-checks.yml`, and `validation_runner.yml`. | ||
| 4. Inspect generated reports under [`docs/reports/`](docs/reports/). |
There was a problem hiding this comment.
There is a discrepancy between the report locations mentioned here and the actual output of the validation scripts. This line directs reviewers to docs/reports/, but the 'CFI artifact model' (line 127) and the scripts/validate.py implementation (which writes to a root reports/ directory) suggest that some artifacts are stored in a top-level reports/ folder. Please ensure the README accurately reflects where all generated reports can be found.
| python scripts/validate.py token | ||
| python scripts/validate.py forensic | ||
| python benchmarks/run_kvtc_v7_benchmarks.py --iterations 1 --warmups 0 | ||
| python dashboard/industrial_dashboard.py --once |
There was a problem hiding this comment.
The command python dashboard/industrial_dashboard.py --once is listed without context. In the previous version of the README, the dashboard command included host and port configuration for running a persistent server. It should be clarified if --once is intended as a smoke test or a specific validation check, as maintainers might otherwise expect a persistent dashboard process to start.
Motivation
Description
README.mdinto a premium enterprise-style README with a modern hero (title, positioning statement, live Vercel demo link, CI badges) and concise architecture highlights..github/workflows/*, andcontracts/hash-chilli-cloud-ci-result.schema.json) and added maintainer commands and safety boundaries for reviewers and maintainers.Testing
git diff --checkto ensure no whitespace/patch issues; the check succeeded.docs/DEMO_WALKTHROUGH.md,docs/SHOWCASE_READINESS.md,docs/BENCHMARK_EXPLANATION.md,docs/API_SURFACE.md,.github/workflows/ci.yml,.github/workflows/agent-checks.yml,.github/workflows/validation_runner.yml,contracts/hash-chilli-cloud-ci-result.schema.json) exist; the script passed.Codex Task