docs(dir): add guide for choosing a Directory setup - #1970
Conversation
Signed-off-by: Catarina Paralta <clouropa@cisco.com>
📝 WalkthroughWalkthroughAdded a “Choosing a Setup” page with an interactive Directory configuration wizard, topology guidance, styling, MkDocs integration, navigation, and refreshed repository analytics. ChangesDirectory setup chooser
Estimated code review effort: 3 (Moderate) | ~20 minutes Sequence Diagram(s)sequenceDiagram
participant Visitor
participant SetupChooser
participant SetupGuide
Visitor->>SetupChooser: Select discovery and storage options
SetupChooser->>SetupChooser: Determine the matching configuration
SetupChooser->>SetupGuide: Display recommendation and deep links
Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/content/dir/dir-choosing-a-setup.md`:
- Around line 57-58: Correct the bootstrap connection description in the setup
guide to remove the claim that it announces records. State that bootstrapping
joins the node to the DHT and enables searching, while record discovery requires
an explicit store operation followed by routing publish.
🪄 Autofix
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: f1664a4a-b743-46e5-a2fc-e8108e62f356
📒 Files selected for processing (6)
docs/content/dir/.indexdocs/content/dir/dir-choosing-a-setup.mddocs/content/javascripts/dir-repobeats-data.jsdocs/content/javascripts/dir-setup-chooser.jsdocs/content/stylesheets/dir-setup-chooser.cssdocs/mkdocs/mkdocs.yml
| A **bootstrap** connection puts the node on the DHT: it announces its records and can search | ||
| for records held by other nodes. |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟠 Major | ⚡ Quick win
Require an explicit record announcement.
A bootstrap connection does not announce records. The Routing guide requires a store operation followed by routing publish. Without that step, peers cannot discover the records.
Proposed fix
-A **bootstrap** connection puts the node on the DHT: it announces its records and can search
-for records held by other nodes.
+A **bootstrap** connection connects the node to the DHT. After storing a record, call
+`routing publish` to announce it. The node can then search for records held by other nodes.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| A **bootstrap** connection puts the node on the DHT: it announces its records and can search | |
| for records held by other nodes. | |
| A **bootstrap** connection connects the node to the DHT. After storing a record, call | |
| `routing publish` to announce it. The node can then search for records held by other nodes. |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/content/dir/dir-choosing-a-setup.md` around lines 57 - 58, Correct the
bootstrap connection description in the setup guide to remove the claim that it
announces records. State that bootstrapping joins the node to the DHT and
enables searching, while record discovery requires an explicit store operation
followed by routing publish.
Signed-off-by: Aron Kerekes <arkereke@cisco.com>
Signed-off-by: Aron Kerekes <arkereke@cisco.com>
Signed-off-by: Aron Kerekes <arkereke@cisco.com>
New users have no clear way to decide which Directory deployment shape fits them, and the distinction between discovery (who can find your records) and retrieval (who can get the bytes) is easy to get wrong. This adds a "Choosing a Setup" page under Get Started that reduces the decision to two questions and documents the four resulting configurations — private node, public-store node, networked node, and federated — each with a topology diagram that uses dashed edges for discovery and solid for retrieval, plus links onward to the relevant deployment, routing, store, and trust-model pages. An interactive chooser walks readers to the matching section, while the questions also stay in the Markdown so the page works without JavaScript.
Summary by CodeRabbit
New Features
Documentation