Add divider option to Get Started section#11530
Conversation
|
|
📝 WalkthroughWalkthroughIn 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
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 `@en/mkdocs.yml`:
- Line 891: Verify that the removal of `no-collapsible` and addition of
`divider` to the "Get Started" section in mkdocs.yml (line 891) is intentional,
as this change makes the section collapsible instead of always expanded.
Document this behavioral change and the rationale behind it in the pull request
description, explicitly stating that the "Get Started" section now matches the
collapsible behavior of "Install & Setup" and "API Design & Manage" sections.
Ensure the documentation clarifies that this UX change aligns with the intended
navigation pattern.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
| options: | ||
| - verticle-line | ||
| - no-collapsible | ||
| - divider |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Verify how no-collapsible is used elsewhere and confirm the behavioral contract
echo "=== Checking template usage of no-collapsible and divider options ==="
rg -n -C3 --type=html 'no-collapsible.*in.*options|"no-collapsible"'
echo -e "\n=== Checking other expanded_navs configurations ==="
rg -n -A2 'expanded_navs:' en/mkdocs.yml
echo -e "\n=== Verifying divider rendering logic ==="
rg -n -C2 --type=html '"divider".*in.*options'Repository: wso2/docs-apim
Length of output: 222
🏁 Script executed:
#!/bin/bash
echo "=== Checking en/mkdocs.yml around line 891 ==="
if [ -f en/mkdocs.yml ]; then
sed -n '880,910p' en/mkdocs.yml | cat -n
else
echo "File not found at en/mkdocs.yml"
find . -name "mkdocs.yml" -type f | head -20
fi
echo -e "\n=== Looking for nav-item template files ==="
find . -name "*nav*item*" -type f | head -20
echo -e "\n=== Checking for theme directory ==="
find en/theme -type f -name "*.html" 2>/dev/null | head -20
echo -e "\n=== Searching for 'no-collapsible' in the repo ==="
rg -i 'no-collapsible' --type-list | head -5
rg -i 'no-collapsible' -l | head -20Repository: wso2/docs-apim
Length of output: 2461
🏁 Script executed:
#!/bin/bash
echo "=== Reading nav-item.html template ==="
cat -n en/theme/material/partials/nav-item.html
echo -e "\n=== Searching for 'no-collapsible' references in repo ==="
rg -i 'no-collapsible' | head -30
echo -e "\n=== Searching for 'divider' handling in code ==="
rg -i 'divider' en/theme/ | head -30Repository: wso2/docs-apim
Length of output: 17556
Confirm this behavioral change is intentional and documented.
Removing no-collapsible and adding divider makes the "Get Started" section collapsible (users can expand/expand it), where it was previously always expanded. The template logic in nav-item.html (lines 122–125) shows that no-collapsible disables the collapse icon; removing it enables it.
This aligns with "Install & Setup" and "API Design & Manage" sections, which both use the same verticle-line + divider configuration. While the pattern suggests intentionality, the empty PR description leaves the UX change undocumented. Ensure this behavioral change matches the intended user experience.
🤖 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 `@en/mkdocs.yml` at line 891, Verify that the removal of `no-collapsible` and
addition of `divider` to the "Get Started" section in mkdocs.yml (line 891) is
intentional, as this change makes the section collapsible instead of always
expanded. Document this behavioral change and the rationale behind it in the
pull request description, explicitly stating that the "Get Started" section now
matches the collapsible behavior of "Install & Setup" and "API Design & Manage"
sections. Ensure the documentation clarifies that this UX change aligns with the
intended navigation pattern.
2 participants
The "Get Started" section in the left sidebar was missing the dropdown arrow icon, unlike other expandable sections such as "Install & Setup" and "Tutorials".
This fix adds the missing indicator so the sidebar is visually consistent.
Fixes #5109