docs: simplify KEYSTONE README for non-technical readers - #2
Conversation
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 0f0dc007d2
ℹ️ 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".
| | [ACCELERATOR_CONTRACT.md](ACCELERATOR_CONTRACT.md) | Requirements a GPU/NPU/other accelerator backend must satisfy before it is treated as supported. | | ||
| | [TELEMETRY_PROCESSOR.md](TELEMETRY_PROCESSOR.md) | Telemetry processor implementation and usage. | |
There was a problem hiding this comment.
The rewrite removes the previous Python SDK installation and usage section, but this new documentation map does not replace it. A repo-wide search of README.md and docs/ now finds no mention of Python, the keystone-sdk package, or pip install -e python, even though python/setup.py and the public SDK remain present. Python consumers therefore lose the only discoverable installation and API entry point; add a Python SDK document or retain a concise link and install command here.
Useful? React with 👍 / 👎.
| 1. **No requirement for specialized accelerator hardware.** The current core runs on CPU. | ||
| 2. **Optional acceleration stays optional.** OpenMP, Fortran, SIMD paths, archive support, classification, and QIHSE integration can be selected independently. | ||
| 3. **Backend choice is observable.** The runtime exposes whether a decision came from a fast path, measurement, cache, or fallback rather than hiding the execution path. |
There was a problem hiding this comment.
For deployments using this statement to build a minimal core library, classification cannot currently be selected independently: the Makefile unconditionally adds src/dsmil_model_bridge.c and src/dsmil_micro_model.c, and exposes no classification feature switch. This makes the new deployment guarantee inaccurate; either gate those sources behind a build option or clarify that classification is optional only at API/runtime use, not at build time.
Useful? React with 👍 / 👎.
1 participant
Reworks the root README around business value and progressive disclosure.
Key changes:
docs/TECHNICAL_OVERVIEW.md;docs/README.mdas a documentation map;ROADMAP.mdlink fromSTATUS_SUMMARY.md.The root README is reduced by 403 lines while preserving technical credibility and links to the deeper material.