docs: move sidebar external links and add icons (#241) - #245
docs: move sidebar external links and add icons (#241)#245deshmukhpranali wants to merge 4 commits into
Conversation
…#241) Remove Examples Hub and Release Notes from the top nav (menu.main). Add three sidebar stub entries using Docsy's manualLink parameter so the links appear in the docs sidebar and open directly in a new tab: Examples Hub (GitHub examples dir), Release Notes (GitHub releases), and Solo on GitHub (GitHub repo). Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> Signed-off-by: Pranali Deshmukh <pranali.deshmukh@swirldslabs.com>
Add Font Awesome icons to Examples Hub, Release Notes, and Solo on GitHub sidebar entries via Docsy's Icon frontmatter param. Position icons to align with foldable-nav caret arrows and add a visible separator above the group. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> Signed-off-by: Pranali Deshmukh <pranali.deshmukh@swirldslabs.com>
Update manualLink to include #solo anchor so the link scrolls directly to the Solo heading in the README, bypassing repo badges. Co-authored-by: jeromy-cannon <jeromy-cannon@users.noreply.github.com> Signed-off-by: Pranali Deshmukh <pranali.deshmukh@swirldslabs.com>
632768c
|
Thanks for the detailed suggestion, @Reccetech. After reviewing, we'd prefer to keep the current approach for a few reasons: The examples/ README in the Solo repo already covers exactly what you described - a full table of all examples with descriptions, prerequisites (taskfile CLI + a configured kubeconfig), how to run them, and how to download zip archives from releases. When users click the "Examples Hub" sidebar link, they land directly on that page. Duplicating that content in solo-docs would create a maintenance burden: every time an example is added or changed in the Solo repo, the docs page would need a separate update. Keeping the Solo repo as the single source of truth avoids that drift. For contextual discovery, the relevant advanced-setup pages already link directly to specific examples where they're most useful. The sidebar "Examples Hub" entry then serves as the full inventory for users who want everything in one place. |
4 participants
Description:
Related issue(s):
Fixes #241
Notes for reviewer:
UI/UX changes
Checklist