docs: add Soroban storage strategies guide - #2649
Conversation
|
Preview is available here: |
8806e46 to
e0d7376
Compare
|
Preview is available here: |
1 similar comment
|
Preview is available here: |
|
Preview is available here: |
There was a problem hiding this comment.
Pull request overview
Adds a production-oriented Soroban storage strategies guide with interactive diagrams and local Markdown preview support.
Changes:
- Documents eleven storage patterns, limits, and decision guidance.
- Adds animated, accessible SVG diagrams.
- Adds development middleware for Markdown source previews.
Recommendation: NEEDS-CHANGES — address the stored review comments, especially the unsafe allowance example, unsupported protocol claim, middleware defects, and infinite animations.
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 7 comments.
Show a summary per file
| File | Description |
|---|---|
docs/build/guides/storage/storage-strategies.mdx |
Adds the storage guide. |
src/components/StorageStrategies/index.ts |
Exports the diagram component. |
src/components/StorageStrategies/diagrams.tsx |
Defines storage diagrams. |
src/components/StorageStrategies/diagrams.css |
Styles and animates diagrams. |
src/components/StorageStrategies/AnimatedDiagram.tsx |
Adds playback and restoration controls. |
src/plugins/markdown-source-dev/index.ts |
Serves Markdown during development. |
docusaurus.config.ts |
Registers the development plugin. |
routes.txt |
Records the new documentation route. |
The three looping diagrams auto-started on scroll and never stopped, breaking the component's plays-once contract (WCAG 2.2.2); capped at 2-3 iterations (~5s) since Replay covers re-watching. The Strategy 4 snippet claimed the deadline was checked but only stored it — now it shows the write-side validation and read-side expiration guard from the canonical token example.
Serving raw markdown under docusaurus start meant re-deriving source paths from URLs, which missed README-backed section pages, /docs.md, and front-matter slugs, and required a fragile re-install of the eval source map middleware that silently failed on Docusaurus 3.10. Not worth the surface: the Open Markdown button works in production and PR previews, where docusaurus-markdown-source-plugin resolves sources from route metadata.
|
Preview is available here: |
e82a82f to
6d0e48d
Compare
|
Preview is available here: |
ElliotFriend
left a comment
ElliotFriend
left a comment
There was a problem hiding this comment.
overall, this is great!!
i left a few thoughts and nitpicks throughout, as well. the big one that i'd love confirmation on is the max ledger entry size. the lab says the limit for all entries is 128 KiB, not only the Wasm entries. it's listed as 64 KiB in this guide several times.
|
The value on https://lab.stellar.org/network-limits is incorrect, there are actually 2 distinct limits:
That can be verified through the CLI with As for the remaining comments, I'll address them shortly. |
|
Preview is available here: |
|
Preview is available here: |
ElliotFriend
left a comment
ElliotFriend
left a comment
There was a problem hiding this comment.
nice work!! thanks SO MUCH for putting this together! 🎉
👀 Page available here
What
Why
Known limitations