Store and Retrieve a File using the Storage UI#298
Conversation
danisharora099
left a comment
There was a problem hiding this comment.
Heads up — this one needs a couple of fixes before it's followable end to end. The build and the app itself are fine (I got nix build producing the plugin and nix run bringing the app up — it loads storage_module, spawns the ui-host, and initializes StorageBackend), but Step 1 has a real gap:
- Step 1 says "clone the repository" but never says which one or gives the command, and the only repo linked above is logos-storage-module — which is the wrong one (that builds the module, not the UI). The UI app is in logos-co/logos-storage-ui, which isn't named or linked anywhere. A new reader can't actually start. Suggested the clone command inline.
- the
result/tree in Step 1.3 doesn't match reality — it listsbin/logos-storage-ui-app,logoscore, amodules/dir, etc., none of which exist. The default build just producesresult/lib/storage_ui_plugin.dylib(+ the replica factory). Same reason the "run from result/ directly:./result/bin/logos-storage-ui-app" line won't work — there's no result/bin;nix runis the way (which the doc itself says higher up). - the "Enter development shell" code block is missing its closing fence, so it runs into the next step and mangles the rest of the page. Fixed inline.
- frontmatter:
authorsis empty andtopicsis[].
I couldn't test the actual storage flow (Steps 2–5) — the connectivity setup, share, and download-by-CID all need a real display plus a router with UPnP/port-forwarding and live peers, which I don't have here. Worth Red Team dogfooding on a real network.
Calling this blocking on the Step 1 issues (clone target + the result/ tree), but they're quick fixes.
Co-authored-by: Danish Arora <35004822+danisharora099@users.noreply.github.com>
weboko
left a comment
There was a problem hiding this comment.
Dogfooded on x86_64 Linux. I could not complete Steps 3–5 (need a GUI display and live peers for the storage network), but I reviewed the doc and verified the build path.
Unclosed code fence at Step 1.4 (still broken despite the resolved thread):
The nix develop block is opened with ```bash but never closed. The thread at line 85 was resolved without the fix being applied — the code in the PR still has the unclosed fence. As a result every step after Step 1.4 (Steps 1.5, 2, 3, 4, 5, and all troubleshooting) renders inside the bash block, making the page unreadable. The fix is one line:
nix develop
```
Potentially misleading prerequisites — CMake, Ninja, pkg-config:
The prerequisites section lists CMake (3.16+), Ninja, and pkg-config as required installs. The build path in this doc is entirely through nix build and nix run, which pull all build-time tools from the Nix closure. If these tools are actually required outside of Nix (for example, by a vendored fetch step in the flake), the doc should show a step that uses them. If they are not, listing them as prerequisites will confuse readers — especially those who just installed Nix and expect it to handle dependencies.
Related to: #234
Development info from doc packet has been removed as this is a beginner tutorial