Skip to content

chore: fix docs config#233

Merged
KevinVandy merged 1 commit into
mainfrom
fix-docs-config
Jun 30, 2026
Merged

chore: fix docs config#233
KevinVandy merged 1 commit into
mainfrom
fix-docs-config

Conversation

@KevinVandy

@KevinVandy KevinVandy commented Jun 30, 2026

Copy link
Copy Markdown
Member

🎯 Changes

✅ Checklist

  • I have followed the steps in the Contributing guide.
  • I have tested this code locally with pnpm run test:pr.

🚀 Release Impact

  • This change affects published code, and I have generated a changeset.
  • This change is docs/CI/dev-only (no release).

Summary by CodeRabbit

  • Documentation
    • Reorganized the “Examples” navigation in the docs for several API sections.
    • Moved vanilla example links into a more consistent nested framework grouping, improving the structure of the sidebar and making examples easier to browse.

@KevinVandy KevinVandy merged commit cac705b into main Jun 30, 2026
5 of 6 checks passed
@KevinVandy KevinVandy deleted the fix-docs-config branch June 30, 2026 16:06
@coderabbitai

coderabbitai Bot commented Jun 30, 2026

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 4c042d43-942f-41ee-9a76-b507f8a82bd0

📥 Commits

Reviewing files that changed from the base of the PR and between 0229539 and 4d43b23.

📒 Files selected for processing (1)
  • docs/config.json

📝 Walkthrough

Walkthrough

In docs/config.json, vanilla example navigation links for five API sections (Debouncer, Throttler, Rate Limiter, Queue, Batcher) are moved from the section-level children array into a frameworksvanillachildren grouping. The route paths remain unchanged.

Docs Navigation Restructure

Layer / File(s) Summary
Vanilla examples nested under frameworks for all five sections
docs/config.json
For Debouncer, Throttler, Rate Limiter, Queue, and Batcher Examples sections, top-level children arrays are cleared and the vanilla example links (liteDebounce/LiteDebouncer, liteThrottle/LiteThrottler, liteRateLimit/LiteRateLimiter, liteQueue/LiteQueuer, liteBatch/LiteBatcher) are placed under frameworks.vanilla.children.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐇 Hop, hop, reorganize!
The vanilla links found their nest,
Tucked under frameworks, neatly dressed.
Five sections tidied, all in a row—
A cleaner config puts on a show! 🌿

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix-docs-config

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

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

@nx-cloud

nx-cloud Bot commented Jun 30, 2026

Copy link
Copy Markdown

View your CI Pipeline Execution ↗ for commit 4d43b23

Command Status Duration Result
nx run-many --targets=build --exclude=examples/** ✅ Succeeded 1s View ↗

☁️ Nx Cloud last updated this comment at 2026-06-30 16:06:32 UTC

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant