8000 docs: fix on-this-page for composable and directives pages by dwgray · Pull Request #2742 · bootstrap-vue-next/bootstrap-vue-next · GitHub
[go: up one dir, main page]
Skip to content

docs: fix on-this-page for composable and directives pages #2742

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Jun 10, 2025
Merged

docs: fix on-this-page for composable and directives pages #2742

merged 1 commit into from
Jun 10, 2025

Conversation

dwgray
Copy link
Member
@dwgray dwgray commented Jun 9, 2025 •
edited by coderabbitai bot
Loading

Describe the PR

When I wrote the code to drive the OTP sidebar off of the scrollSpy results, I missed the fact that the directives and composible pages "hid" the H1 header in a couple of layers of divs. This broke the whole thing for those pages. I'm going to spend some time soon cleaning up (and hopefully unifying and simplifying) how we handle the docs for components, directives, and composables, but this fixes the immediate bug.

Small replication

Directive and composable document pages.

PR checklist

What kind of change does this PR introduce? (check at least one)

  • Bugfix 🐛 - fix(...)
  • Feature - feat(...)
  • ARIA accessibility - fix(...)
  • Documentation update - docs(...)
  • Other (please describe)

The PR fulfills these requirements:

  • Pull request title and all commits follow the Conventional Commits convention or has an override in this pull request body This is very important, as the CHANGELOG is 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 denied

Summary by CodeRabbit

  • New Features
    • Scrollspy now also tracks direct h1 headings, improving navigation and highlighting for these elements in the documentation.

@bolt-new-by-stackblitz Bolt.new (by StackBlitz)
Copy link

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

@coderabbitai coderabbitai
Copy link
coderabbitai bot commented Jun 9, 2025 •
edited
Loading

Walkthrough

The change updates the contentQuery selector in the useScrollspy hook within the documentation layout, adding :scope h1 to the list of monitored elements. This adjustment enables the scrollspy to track direct h1 elements in addition to previously monitored selectors.

Changes

File(s) Change Summary
apps/docs/.vitepress/theme/Layout.vue Modified contentQuery in useScrollspy to include :scope h1 for expanded scroll tracking.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant LayoutVue
    participant useScrollspy

    User->>LayoutVue: Navigate or scroll through docs
    LayoutVue->>useScrollspy: Initialize with updated contentQuery (includes :scope h1)
    useScrollspy-->>LayoutVue: Report scroll position and active element
    LayoutVue-->>User: Highlight active section (now includes h1s)
Loading

Possibly related PRs

Poem

Hopping through docs, I scroll and spy,
Now h1s catch my rabbit eye!
With every hop, the headers gleam,
Scrollspy’s sharper than it’s ever been.
🐇✨

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9a4b648 and c04965f.

📒 Files selected for processing (1)
  • apps/docs/.vitepress/theme/Layout.vue (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: test-unit
  • GitHub Check: build
  • GitHub Check: test-lint
🔇 Additional comments (1)
apps/docs/.vitepress/theme/Layout.vue (1)

205-210: Correctly include h1 in the scrollspy selector
Adding :scope h1 ensures the main heading is now picked up by the OTP sidebar on composable and directive docs where the h1 lived outside the previous > div > [id] pattern.

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.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support pag 8000 e for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@pkg-pr-new pkg.pr.new
Copy link
pkg-pr-new bot commented Jun 9, 2025

bsvn-vite-ts

npm i https://pkg.pr.new/bootstrap-vue-next/bootstrap-vue-next@2742

npm i https://pkg.pr.new/bootstrap-vue-next/bootstrap-vue-next/@bootstrap-vue-next/nuxt@2742

commit: c04965f

@VividLemon VividLemon merged commit a7c66f1 into bootstrap-vue-next:main Jun 10, 2025
5 checks passed
xvaara added a commit to xvaara/bootstrap-vue-next that referenced this pull request Jun 10, 2025
@xvaara
Merge remote-tracking branch 'upstream/main'
757f949 
* upstream/main:
  docs: fix on-this-page for composable and directives pages (bootstrap-vue-next#2742)
  fix(BTableLite): field attribute isRowHeader now being respected (bootstrap-vue-next#2713)
  docs: change example styles to be single-attribute-per-line (bootstrap-vue-next#2731)
  fix(BTabs): Add type=button to buttons to prevent form submission (bootstrap-vue-next#2740)
  docs: fix unplugin-vue-components issue (bootstrap-vue-next#2724)
  fix(bforminput): abort debouncing if blur occurs
  chore: release main (bootstrap-vue-next#2735)
  fix(BTabs): correct id/index on ssr (bootstrap-vue-next#2726)
  Small fixes on 2025-06-06 (bootstrap-vue-next#2734)
  docs(BPopover): Parity pass (bootstrap-vue-next#2701)
  chore: release main
  Fix some tabs bugs, commit the previous pr override (bootstrap-vue-next#2720)
  chore: release main (bootstrap-vue-next#2698)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@VividLemon VividLemon VividLemon approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@dwgray @VividLemon
0