feat(docs): enhance README with interactive result links and references
- add links to interactive HTML results for storage format evaluation and foreign-key architecture study - update descriptions in README to reflect the new structure of research documents - clarify the contents of the research directory in the README
This commit is contained in:
16
README.md
16
README.md
@@ -12,8 +12,21 @@ the measurements to 600 GB - 6 TB, and produces a ranked decision report for
|
|||||||
five laboratory use cases: analysis, reporting, search/filtering, archiving,
|
five laboratory use cases: analysis, reporting, search/filtering, archiving,
|
||||||
and inter-lab exchange.
|
and inter-lab exchange.
|
||||||
|
|
||||||
|
**Results - interactive, single-file HTML (open in a browser or download and share):**
|
||||||
|
|
||||||
|
- **[Storage Format Evaluation](https://git.boskadoff.com/Public/LabDataStorageEvaluation/raw/branch/master/docs/research/Tribology_Storage_Evaluation.html)** -
|
||||||
|
the full study results: dashboard, measured matrix, projections to 6 TB,
|
||||||
|
hardware bill of materials, weighted scoring and verdict
|
||||||
|
(source: [docs/research/Tribology_Storage_Evaluation.html](docs/research/Tribology_Storage_Evaluation.html)).
|
||||||
|
- **[Foreign-Key Architecture Study](https://git.boskadoff.com/Public/LabDataStorageEvaluation/raw/branch/master/docs/research/Tribology_FK_Architecture.html)** -
|
||||||
|
the measured key-schema study behind the relational design decision
|
||||||
|
(source: [docs/research/Tribology_FK_Architecture.html](docs/research/Tribology_FK_Architecture.html)).
|
||||||
|
|
||||||
|
Reference documents:
|
||||||
|
|
||||||
- Task specifications: [docs/specs/](docs/specs/) (plan + tasks 01-11).
|
- Task specifications: [docs/specs/](docs/specs/) (plan + tasks 01-11).
|
||||||
- Binding conventions: [docs/rules/](docs/rules/) and [CLAUDE.md](CLAUDE.md).
|
- Binding conventions: [docs/rules/](docs/rules/) and [CLAUDE.md](CLAUDE.md).
|
||||||
|
- Full decision report (markdown): [out/report/REPORT.md](out/report/REPORT.md).
|
||||||
|
|
||||||
## Goals
|
## Goals
|
||||||
|
|
||||||
@@ -144,8 +157,7 @@ docs/
|
|||||||
Initial_Prompt.md the generative prompt behind specs 00-11 (provenance, non-binding)
|
Initial_Prompt.md the generative prompt behind specs 00-11 (provenance, non-binding)
|
||||||
specs/ task specifications 00-11 (WHAT to build)
|
specs/ task specifications 00-11 (WHAT to build)
|
||||||
rules/ binding conventions (HOW work is done)
|
rules/ binding conventions (HOW work is done)
|
||||||
research/ measured design studies (e.g. FK key-schema study)
|
research/ measured design studies and interactive result pages
|
||||||
examples/ imported reference materials (not binding)
|
|
||||||
out/ ALL generated artifacts (reproducible; bulk git-ignored,
|
out/ ALL generated artifacts (reproducible; bulk git-ignored,
|
||||||
report/ config/ .done/ committed - see .gitignore):
|
report/ config/ .done/ committed - see .gitignore):
|
||||||
config/ csv/ json/ sqlite/ pg/ rdf/ bench/ report/ .done/
|
config/ csv/ json/ sqlite/ pg/ rdf/ bench/ report/ .done/
|
||||||
|
|||||||
@@ -533,7 +533,7 @@ CREATE TABLE friction_cycles (
|
|||||||
<div class="foot">
|
<div class="foot">
|
||||||
Measured 2026-07-11 on the deterministic simulated corpus (seed 20260711, 141.8 MiB CSV) · SQLite, warm OS cache, best of 3 runs ·
|
Measured 2026-07-11 on the deterministic simulated corpus (seed 20260711, 141.8 MiB CSV) · SQLite, warm OS cache, best of 3 runs ·
|
||||||
scripts: <span class="mono">measure_key_variants.py</span> (build + size + load + Q1) and <span class="mono">read_benchmarks.py</span> (six read patterns) ·
|
scripts: <span class="mono">measure_key_variants.py</span> (build + size + load + Q1) and <span class="mono">read_benchmarks.py</span> (six read patterns) ·
|
||||||
companion page: <span class="mono">Tribology_Ontology.html</span> (measurement-result registry).
|
companion page: <a href="https://git.boskadoff.com/Public/LabDataStorageEvaluation/raw/branch/master/docs/research/Tribology_Storage_Evaluation.html" style="color:#1f5fdb;text-decoration:none">Storage Format Evaluation</a> (full study results).
|
||||||
</div>
|
</div>
|
||||||
</section>
|
</section>
|
||||||
|
|
||||||
|
|||||||
@@ -78,8 +78,6 @@ an en-dash.
|
|||||||
content, not typographic substitutions. UTF-8 throughout is the right
|
content, not typographic substitutions. UTF-8 throughout is the right
|
||||||
answer. (Repository artifacts are English; this matters only for quoted
|
answer. (Repository artifacts are English; this matters only for quoted
|
||||||
material.)
|
material.)
|
||||||
- **Imported reference materials** in `docs/examples/` are kept verbatim as
|
|
||||||
received; they are not binding documents.
|
|
||||||
|
|
||||||
## 4. Detection / enforcement
|
## 4. Detection / enforcement
|
||||||
|
|
||||||
@@ -89,8 +87,7 @@ future detector is documented here so it can be built consistently:
|
|||||||
|
|
||||||
- **What it flags.** Any occurrence of the Unicode codepoints in the section 1
|
- **What it flags.** Any occurrence of the Unicode codepoints in the section 1
|
||||||
substitution table inside in-scope files. The section 3 exemptions
|
substitution table inside in-scope files. The section 3 exemptions
|
||||||
(scientific notation, international content, `docs/examples/`) are the only
|
(scientific notation, international content) are the only carve-outs.
|
||||||
carve-outs.
|
|
||||||
- **Exit behavior.** Non-zero exit when any flagged codepoint is found under
|
- **Exit behavior.** Non-zero exit when any flagged codepoint is found under
|
||||||
the scan roots, so it can later gate a commit hook or a build step.
|
the scan roots, so it can later gate a commit hook or a build step.
|
||||||
- **Tooling.** When this detector is created it MUST be a PowerShell script
|
- **Tooling.** When this detector is created it MUST be a PowerShell script
|
||||||
|
|||||||
Reference in New Issue
Block a user