Skip to content

Docs/roadmap tutorials glossary playground audit - #455

Merged
maugauwi-hash merged 4 commits into
ethos-protocol:mainfrom
levi0005:docs/roadmap-tutorials-glossary-playground-audit
Aug 31, 2026
Merged

Docs/roadmap tutorials glossary playground audit#455
maugauwi-hash merged 4 commits into
ethos-protocol:mainfrom
levi0005:docs/roadmap-tutorials-glossary-playground-audit

Conversation

@levi0005

Copy link
Copy Markdown
Contributor

Closes #412
Closes #413
Closes #414
Closes #415

Summary of the 4 commits on that branch:

  1. Roadmap traceability — docs/roadmap.md: issue/PR refs + status column per milestone, cross-checked against docs/issues-32-38-39-40.md, roadmap-update step added to issue-closing checklist.
  2. Video tutorial audit — docs/video-tutorials.md: "Last verified" date on all 17 entries, 5 flagged for re-recording (T-201, T-204, T-401, T-402, T-502).
  3. FAQ/glossary consistency — added missing "Slice"/"Attestor" glossary terms, cross-linked FAQ to glossary, added scripts/check_glossary_terms.py to flag inconsistent term usage.
  4. Playground isolation — documented 3 isolation layers in docs/playground.md, added scripts/check_playground_isolation.sh (wired into CI) and isolation tests in backend/src/cache_partition.rs.

Adds an Issue/PR column and a done/in-progress/not-started status column
to each roadmap milestone so progress is auditable at a glance. Cross-checks
the milestone list against docs/issues-32-38-39-40.md and records the four
already-shipped slice-layer features that weren't represented as roadmap
rows. Adds a roadmap-update step to the issue-closing checklist.
… dates

Adds a "Last verified" field to each of the 17 tutorial entries recording
when its outline was last checked against current API/contract function
signatures. Flags T-201, T-204, T-401, T-402, and T-502 as needing
re-recording (signature/status drift risk) and adds an Audit Findings
section with follow-up filing guidance for each flagged tutorial.
…ript

Adds missing "Slice" and "Attestor" definitions to glossary.md — both terms
are used across slice-*.md and issues-32-38-39-40.md but were previously
undefined, and "slice" vs "vault slice" were used interchangeably. Cross-
references faq.md to glossary.md as the terminology source of truth. Adds
scripts/check_glossary_terms.py, a lightweight scanner that flags docs
mixing multiple spelling variants of the same glossary term family
(slice/vault slice, check-in/checkin, webauthn, attestor/attester), usable
as a CI gate via --strict.
Documents the three isolation layers that keep the Playground (docs/
playground.md, backend/simulator.html) from leaking data into or out of
production: separate Stellar networks for testnet/standalone vs mainnet,
tenant-partitioned application-level cache keys, and a CI-enforced config
check.

Adds scripts/check_playground_isolation.sh, wired into
.github/workflows/ci.yml, which fails the build if the playground network
is set to "mainnet" or its resolved rpc_url/contract id in
environments.toml matches the [mainnet] section.

Adds isolation tests to backend/src/cache_partition.rs asserting playground
writes never appear in production reads and vice versa, reusing the
existing tenant-partitioning mechanism (playground and production treated
as two tenant partitions of the same PartitionedCache).
@drips-wave

drips-wave Bot commented Aug 29, 2026

Copy link
Copy Markdown

@levi0005 Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits.

You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀

Learn more about application limits

@maugauwi-hash
maugauwi-hash merged commit 14337be into ethos-protocol:main Aug 31, 2026
2 of 4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

2 participants