Align developer guide series into a progressive, bee-js-focused path#809
Merged
Conversation
Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
docs showed downloadReference() but actual read.js uses download() Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…og content - Remove dedicated swarm-cli sections and TabItems across the dev guide series (the guides target devs building apps with bee-js; brief one-off swarm-cli commands remain where they're useful, e.g. swarm-cli download in files.md) - Restructure host-your-website.md: drop swarm-cli walkthrough, keep bee-js path; move ENS resolver tip into the ENS section where it's relevant - Replace gateway.md test step with a working public reference instead of uploading new content via swarm-cli - Fix the simple-blog walkthrough in dynamic-content.md to match the actual code structure (html.js is a shared module, not inline functions) - Replace the routing.md swarm-cli deploy with the bee-js upload script that ships with the routing example - Fix introduction.md card titles and a trailing-space href that prior changes left in place - Remove unused Tabs imports from files that no longer use them
✅ Deploy Preview for test-twitter-preview-testing-3 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
The ENS section heading became 'Optional: Connect Site to ENS Domain', so the anchor is now #optional-connect-site-to-ens-domain. Updates the two links that still pointed at the old #connect-site-to-ens-domain.
This reverts commit 762d318.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Turns the 7-guide developer series into a coherent, progressive path where each guide builds on the previous one, introduces one new concept, and links to a complete runnable example in the examples repo (companion PR: ethersphere/examples#5).
Guide order: Upload and Download → Host a Webpage → Manage Files → Website Routing → Run a Gateway → Dynamic Content → Multi-Author Blog.
Narrative & navigation
Focus on bee-js
The series targets developers building apps, so parallel
swarm-cliwalkthroughs were removed:dynamic-content.md(10) andmulti-author-blog.md(7)swarm-clisections fromhost-your-website.mdandupload-and-download.mdrouting.mdwith the bee-js upload scriptswarm-clicommands where they make sense (e.g.swarm-cli downloadinfiles.md)TabsimportsContent fixes
host-your-website.md: bee-js path promoted to the main flow; ENS resolver tip moved into the ENS section where it's relevant; feeds section clearly marked "Advanced" with a prerequisite pointer to Dynamic Contentgateway.md: bumped image tag to0.1.6; test step now uses a working public reference instead of uploading via swarm-clidynamic-content.md: simple-blog walkthrough rewritten to match the actual code (sharedhtml.jsmodule instead of inline duplication); removed a non-existentretryFeedRead()from snippetsmulti-author-blog.md: corrected reader method (download()vsdownloadReference())Test plan
.env/script/npm names cross-checked between docs and examplesupload-and-download.mdverified against a live nodeswarm-gateway:0.1.6pulled and run,/healthOK, documented test reference served correctlynpm run buildin CI)