Add comprehensive useScrollspy documentation #2812

Copilot · 2025-08-19T23:32:08Z

The useScrollspy composable documentation is now complete with working interactive examples, proper TypeScript support, and follows the established documentation patterns in the repository.

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Copilot · 2025-08-19T23:32:10Z

@VividLemon 👋 This repository doesn't have Copilot instructions. With Copilot instructions, I can understand the repository better, work faster and produce higher quality PRs.

I can generate a .github/copilot-instructions.md file for you automatically. Click here to open a pre-filled issue and assign it to me. I'll write the instructions, and then tag you for review.

bolt-new-by-stackblitz · 2025-08-19T23:32:11Z

Run & review this pull request in StackBlitz Codeflow.

Co-authored-by: VividLemon <31498096+VividLemon@users.noreply.github.com>

VividLemon · 2025-08-19T23:56:17Z

@copilot A new copilot instruction file has been added

Co-authored-by: VividLemon <31498096+VividLemon@users.noreply.github.com>

Copilot · 2025-08-19T23:59:55Z

@copilot A new copilot instruction file has been added

Thanks for letting me know! I've also cleaned up the PR by removing accidentally committed build artifacts and updated the .gitignore to prevent similar issues in the future (7fa3fd8).

coderabbitai · 2025-08-26T15:17:36Z

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

🪧 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.
- 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.
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 the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Join our Discord community for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

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

Status, Documentation and Community

Visit our Status Page to check the current availability of CodeRabbit.
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.

VividLemon · 2025-08-26T15:18:01Z

@dwgray Can you review this please?

pkg-pr-new · 2025-08-26T15:20:20Z

bsvn-vite-ts

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

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

commit: 372d922

dwgray · 2025-08-26T18:50:26Z

@copilot please refactor the examples into their own files by creating a demo directory at the root of the .composables directory and placing them there. You can use components/nav.md as an example of how these demo files are referenced.

Moved all inline examples from useScrollspy.md into separate demo files following the established pattern used in components documentation: - Created demo directory in composables - Split examples into UseScrollspyBasic.vue, UseScrollspyManual.vue, and UseScrollspyCustomQuery.vue - Updated markdown to reference demo files using <<< DEMO syntax - Removed inline script setup and dependencies Co-authored-by: dwgray <5083020+dwgray@users.noreply.github.com>

Copilot · 2025-08-26T18:59:45Z

@copilot please refactor the examples into their own files by creating a demo directory at the root of the .composables directory and placing them there. You can use components/nav.md as an example of...

Done! I've refactored all the examples into separate demo files following the pattern used in components documentation.

Created:

demo/UseScrollspyBasic.vue - Basic scroll tracking example
demo/UseScrollspyManual.vue - Manual mode example
demo/UseScrollspyCustomQuery.vue - Custom content query example

The markdown file now uses the <<< DEMO ./demo/FileName.vue#template{vue-html} syntax to reference these files. This follows the same pattern as components/nav.md and makes the documentation more maintainable.

Commit: f0c6bd5

apps/docs/src/docs/composables/useScrollspy.md

Co-authored-by: dwgray <5083020+dwgray@users.noreply.github.com>

apps/docs/src/docs/composables/demo/UseScrollspyBasic.vue

apps/docs/src/docs/composables/demo/UseScrollspyCleanup.fragment

apps/docs/src/docs/composables/demo/UseScrollspyCustomRoot.fragment

apps/docs/src/docs/composables/demo/UseScrollspyDynamicContent.fragment

…e files, add types Co-authored-by: dwgray <5083020+dwgray@users.noreply.github.com>

dwgray

@copilot useBreadcrumb is not showing up in the table of contenst, it must be added to the composablesList in TableOfContentsNav.vue

apps/docs/src/docs/composables/demo/UseScrollspyCleanup.vue

apps/docs/src/docs/composables/demo/UseScrollspyCustomRoot.vue

apps/docs/src/docs/composables/demo/UseScrollspyDynamicContent.vue

Co-authored-by: dwgray <5083020+dwgray@users.noreply.github.com>

Copilot · 2025-08-26T22:20:11Z

@copilot useBreadcrumb is not showing up in the table of contenst, it must be added to the composablesList in TableOfContentsNav.vue

Added useScrollspy to the composablesList in TableOfContentsNav.vue. The composable will now appear in the table of contents. (fba1fba)

VividLemon · 2025-08-28T16:44:47Z

@dwgray If there's nothing else, feel free to merge

apps/docs/src/docs/composables/demo/UseScrollspyManual.vue

apps/docs/src/docs/composables/demo/UseScrollspyBasic.vue

dwgray · 2025-08-28T19:53:13Z

@copilot please correct the two issues that I pointed out in my most recent review

Co-authored-by: dwgray <5083020+dwgray@users.noreply.github.com>

Copilot · 2025-08-28T20:01:29Z

@copilot please correct the two issues that I pointed out in my most recent review

Both TypeScript issues have been resolved:

Fixed ref value access in UseScrollspyManual.vue
Removed unused current variable in UseScrollspyBasic.vue
(4c44beb)

Co-authored-by: dwgray <5083020+dwgray@users.noreply.github.com>

dwgray

lgtm

dwgray · 2025-08-28T22:01:25Z

@VividLemon I had to have copilot make additional changes (it wasn't building at the time you reviewed) - and since I collaborated with copilot on them, it counts as a self-review...

Initial plan

47838d6

Copilot AI assigned Copilot and VividLemon Aug 19, 2025

Copilot started work on behalf of VividLemon August 19, 2025 23:32 View session

Add comprehensive useScrollspy documentation

811da7c

Co-authored-by: VividLemon <31498096+VividLemon@users.noreply.github.com>

Copilot AI changed the title ~~[WIP] useScrollspy documentation~~ Add comprehensive useScrollspy documentation Aug 19, 2025

Copilot AI requested a review from VividLemon August 19, 2025 23:45

Copilot finished work on behalf of VividLemon August 19, 2025 23:45

Copilot started work on behalf of VividLemon August 19, 2025 23:56 View session

Clean up build artifacts and update .gitignore

7fa3fd8

Co-authored-by: VividLemon <31498096+VividLemon@users.noreply.github.com>

Copilot finished work on behalf of VividLemon August 20, 2025 00:00

Merge branch 'main' into copilot/fix-2794

10a3fc9

VividLemon marked this pull request as ready for review August 26, 2025 15:18

Copilot started work on behalf of dwgray August 26, 2025 18:50 View session

Copilot finished work on behalf of dwgray August 26, 2025 19:00

Copilot AI requested a review from dwgray August 26, 2025 19:00

dwgray requested changes Aug 26, 2025

View reviewed changes

Copilot started work on behalf of dwgray August 26, 2025 19:12 View session

refactor: update useScrollspy demo syntax and extract fragments

1004652

Co-authored-by: dwgray <5083020+dwgray@users.noreply.github.com>

Copilot AI requested a review from dwgray August 26, 2025 19:20

Copilot finished work on behalf of dwgray August 26, 2025 19:20

dwgray requested changes Aug 26, 2025

View reviewed changes

Copilot started work on behalf of dwgray August 26, 2025 21:25 View session

Update useScrollspy docs: use useTemplateRef, convert fragments to Vu…

6afb1fe

…e files, add types Co-authored-by: dwgray <5083020+dwgray@users.noreply.github.com>

Copilot AI requested a review from dwgray August 26, 2025 21:35

Copilot finished work on behalf of dwgray August 26, 2025 21:35

dwgray requested changes Aug 26, 2025

View reviewed changes

Copilot started work on behalf of dwgray August 26, 2025 22:15 View session

Fix TypeScript issues and add missing useScrollspy to table of contents

fba1fba

Co-authored-by: dwgray <5083020+dwgray@users.noreply.github.com>

Copilot AI requested a review from dwgray August 26, 2025 22:21

Copilot finished work on behalf of dwgray August 26, 2025 22:21

VividLemon approved these changes Aug 28, 2025

View reviewed changes

dwgray requested changes Aug 28, 2025

View reviewed changes

apps/docs/src/docs/composables/demo/UseScrollspyManual.vue Outdated Show resolved Hide resolved

apps/docs/src/docs/composables/demo/UseScrollspyBasic.vue Outdated Show resolved Hide resolved

Copilot started work on behalf of dwgray August 28, 2025 19:53 View session

fix: resolve TypeScript errors in useScrollspy demo files

4c44beb

Co-authored-by: dwgray <5083020+dwgray@users.noreply.github.com>

Copilot AI requested a review from dwgray August 28, 2025 20:02

Copilot finished work on behalf of dwgray August 28, 2025 20:02

Copilot started work on behalf of dwgray August 28, 2025 21:28 View session

fix: filter scrollspy list to only include items with non-falsey ids

d17db2a

Co-authored-by: dwgray <5083020+dwgray@users.noreply.github.com>

Copilot finished work on behalf of dwgray August 28, 2025 21:38

Copilot started work on behalf of dwgray August 28, 2025 21:48 View session

fix: add explicit PropertyKey type casting to resolve TypeScript error

372d922

Co-authored-by: dwgray <5083020+dwgray@users.noreply.github.com>

Copilot finished work on behalf of dwgray August 28, 2025 21:52

dwgray approved these changes Aug 28, 2025

View reviewed changes

VividLemon merged commit 2538e00 into main Sep 3, 2025
7 checks passed

Uh oh!

Add comprehensive useScrollspy documentation #2812

Add comprehensive useScrollspy documentation #2812

Uh oh!

Conversation

Copilot AI commented Aug 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI commented Aug 19, 2025

Uh oh!

bolt-new-by-stackblitz bot commented Aug 19, 2025

Uh oh!

VividLemon commented Aug 19, 2025

Uh oh!

Copilot AI commented Aug 19, 2025

Uh oh!

coderabbitai bot commented Aug 26, 2025

Review skipped

Chat

Support

CodeRabbit Commands (Invoked using PR/Issue comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Status, Documentation and Community

Uh oh!

VividLemon commented Aug 26, 2025

Uh oh!

pkg-pr-new bot commented Aug 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dwgray commented Aug 26, 2025

Uh oh!

Copilot AI commented Aug 26, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dwgray left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI commented Aug 26, 2025

Uh oh!

VividLemon commented Aug 28, 2025

Uh oh!

Uh oh!

Uh oh!

dwgray commented Aug 28, 2025

Uh oh!

Copilot AI commented Aug 28, 2025

Uh oh!

dwgray left a comment

Choose a reason for hiding this comment

Uh oh!

dwgray commented Aug 28, 2025

Uh oh!

Uh oh!

Uh oh!

Copilot AI commented Aug 19, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

pkg-pr-new bot commented Aug 26, 2025 •

edited

Loading