docs: fix otp for index and reference pages #2819
Conversation
|
|
WalkthroughDemoted several h2 headings to h3 and added anchor IDs in OpenCollectiveMemberDisplay; removed per-tier labels above avatar groups; restructured the Inactive Financial Backers popover trigger to use an h3 with an id. TableOfContentsCard now binds the header h3 id to the route prop. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Suggested reviewers
Poem
Tip 🔌 Remote MCP (Model Context Protocol) integration is now available!Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats. 📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 💡 Knowledge Base configuration:
You can enable these sources in your CodeRabbit configuration. 📒 Files selected for processing (2)
🚧 Files skipped from review as they are similar to previous changes (2)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
✨ Finishing Touches🧪 Generate unit tests
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
commit: |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (1)
apps/docs/src/components/TableOfContentsCard.vue (1)
20-24: Harden slugification: preserve digits, strip diacritics, collapse and trim hyphens for stable anchors.Current regex drops digits, can produce multiple/leading/trailing hyphens, and replaces non‑ASCII letters (e.g., “Café”) with hyphens instead of ASCII equivalents. This yields brittle anchors and increases collision risk.
Apply this diff:
-const toKebabCase = (str = '') => - str - .replace(/[^a-z]/gi, '-') - .replace(/\B([A-Z])/g, '-$1') - .toLowerCase() +const toKebabCase = (str = '') => + str + // Normalize and strip diacritics: "Café" -> "Cafe" + .normalize('NFKD') + .replace(/[\u0300-\u036f]/g, '') + .trim() + // Insert hyphen between camelCase boundaries: "BCard" -> "B-Card" + .replace(/([a-z0-9])([A-Z])/g, '$1-$2') + // Replace any run of non-alphanumerics with a single hyphen + .replace(/[^a-z0-9]+/gi, '-') + // Collapse multiple hyphens and trim edges + .replace(/^-+|-+$/g, '') + .toLowerCase()Additionally, consider centralizing this helper in a small
slugutility (e.g.,apps/docs/src/utils/slug.ts) to keep ID generation consistent across docs components. I can prep that refactor if you want.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (2)
apps/docs/src/components/OpenCollectiveMemberDisplay.vue(3 hunks)apps/docs/src/components/TableOfContentsCard.vue(2 hunks)
🔇 Additional comments (2)
apps/docs/src/components/OpenCollectiveMemberDisplay.vue (2)
5-5: LGTM: explicit h3 IDs align OTP anchors and fix deep-linking.Demoting headings to
h3with stable IDs (administrators,contributors,financial-backers) is a good fit for index/reference pages and should unblock OTP scrolling.Also applies to: 15-15, 25-25
99-110: Semantics check: copy matches logic for active vs. inactive windows.The inactive window (≥ 1 year and < 2 years) matches the explanatory copy below, and > 2 years are omitted as described. No changes needed.
* upstream/main: (32 commits) chore: release main (bootstrap-vue-next#2838) feat(BButtonToolbar): Add keyboard navigation support (bootstrap-vue-next#2837) fix(BFormSelect): modelValue not being applied during SSR (bootstrap-vue-next#2835) feat(BTable): Implement keyboard navigation (bootstrap-vue-next#2834) fix: BOffcanvas responsive SSR compatibility - defer breakpoint evaluation to client-side (bootstrap-vue-next#2833) chore: release main (bootstrap-vue-next#2831) fix(BDropdown): transition broken by inline display styles (bootstrap-vue-next#2832) feat: change useColorMode selector from 'body' to 'html' (bootstrap-vue-next#2830) chore: release main (bootstrap-vue-next#2817) feat: Add headerAttrs prop to BOffcanvas and BModal components docs: Add useScrollspy documentation fix: Remove lazy-modifier warning on FormInput docs (bootstrap-vue-next#2825) feat(BSort)!: Implement initial-sort-direction and move compare from sort-by to fields (bootstrap-vue-next#2777) docs(table): fix incorrect list item (bootstrap-vue-next#2823) docs: Fix grammar in documentation data files (bootstrap-vue-next#2816) doc(BTooltip): Parity pass (bootstrap-vue-next#2762) docs(BOverlay): Parity pass (bootstrap-vue-next#2767) feat: implement BFormRating disabled state (bootstrap-vue-next#2753) (bootstrap-vue-next#2793) docs: fix otp for index and reference pages (bootstrap-vue-next#2819) docs(BApp): add some additional details around legacy plugin use (bootstrap-vue-next#2820) ...
2 participants
Describe the PR
These pages were not formatted in a way that the headings correctly mapped for on this page. I'll think a bit more about getting the OTP code to throw an error (hopefully at build time), but for the moment, this fixes the known issues.
Small replication
Document index and reference page - clicking the OTP links does nothing in some cases.
PR checklist
What kind of change does this PR introduce? (check at least one)
fix(...)feat(...)fix(...)docs(...)The PR fulfills these requirements:
CHANGELOGis generated from these messages, and determines the next version type. Pull requests that do not follow conventional commits or do not have an override will be deniedSummary by CodeRabbit
Documentation
Style