Conversation
…yout, updated branding (#90) * docs: refresh framework positioning across guidance and docs Agent-Logs-Url: https://github.com/bQuery/bQuery/sessions/36417cf4-1567-4e35-933e-1967051cb11e Co-authored-by: JosunLP <[email protected]> * docs: align remaining site pages with framework messaging Agent-Logs-Url: https://github.com/bQuery/bQuery/sessions/36417cf4-1567-4e35-933e-1967051cb11e Co-authored-by: JosunLP <[email protected]> * docs: redesign README header — centred, logo-first, grouped badges Agent-Logs-Url: https://github.com/bQuery/bQuery/sessions/ec99796b-19f5-43d8-a7ab-27ecbcc25467 Co-authored-by: JosunLP <[email protected]> * docs: convert README header to pure HTML; sync VitePress description Agent-Logs-Url: https://github.com/bQuery/bQuery/sessions/bf9758e7-7f83-4859-8268-37e39e564d03 Co-authored-by: JosunLP <[email protected]> * docs: fix badge alt text, sync branding strings, expand llms.txt runtime Agent-Logs-Url: https://github.com/bQuery/bQuery/sessions/7c1febf3-6fb7-472b-bcb8-c99b90cdbc44 Co-authored-by: JosunLP <[email protected]> * Potential fix for pull request finding Co-authored-by: Copilot Autofix powered by AI <[email protected]> Signed-off-by: Jonas Pfalzgraf <[email protected]> * Potential fix for pull request finding Co-authored-by: Copilot Autofix powered by AI <[email protected]> Signed-off-by: Jonas Pfalzgraf <[email protected]> * Potential fix for pull request finding Co-authored-by: Copilot Autofix powered by AI <[email protected]> Signed-off-by: Jonas Pfalzgraf <[email protected]> * Potential fix for pull request finding Co-authored-by: Copilot Autofix powered by AI <[email protected]> Signed-off-by: Jonas Pfalzgraf <[email protected]> --------- Signed-off-by: Jonas Pfalzgraf <[email protected]> Co-authored-by: copilot-swe-agent[bot] <[email protected]> Co-authored-by: JosunLP <[email protected]> Co-authored-by: Jonas Pfalzgraf <[email protected]> Co-authored-by: Copilot Autofix powered by AI <[email protected]>
- Updated version in llms.txt and package.json to 1.11.1 - Enhanced description in package.json - Upgraded @typescript-eslint/eslint-plugin and @typescript-eslint/parser to 8.59.3 - Updated eslint to 10.3.0 - Upgraded globals to 17.6.0 - Updated vite to 8.0.12
github-actions
Bot
added
docs
📝 WalkthroughWalkthroughVersion 1.11.1 patch release updates package metadata and development tooling versions, then systematically rebrands bQuery.js as a "batteries-included TypeScript full-stack web framework" across build configs, package descriptions, documentation, release notes, and developer tool guidance files. ChangesRelease 1.11.1 and Framework Repositioning
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Tip 💬 Introducing Slack Agent: The best way for teams to turn conversations into code.Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.
Built for teams:
One agent for your entire SDLC. Right inside Slack. 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 |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates bQuery.js’s documentation and repo guidance to reflect the 1.11.1 patch release and reposition the project messaging toward a batteries-included, jQuery-inspired full-stack TypeScript framework. It also bumps several dev dependencies (and lockfile) and updates build/file banners to match the new tagline.
Changes:
- Bump package version to 1.11.1 and update dev dependencies (
@typescript-eslint,eslint,globals,vite) plusbun.lock. - Redesign and re-message docs/guidance/README to emphasize full-stack framework capabilities (SSR/server/routing/etc.) and add module maturity/status info.
- Update project taglines in build banners and top-level module docs/comments.
Reviewed changes
Copilot reviewed 17 out of 18 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| vite.umd.config.ts | Updates UMD/IIFE build banner tagline to new positioning. |
| vite.config.ts | Updates ESM build banner tagline to new positioning. |
| src/index.ts | Updates package-level JSDoc tagline/messaging. |
| README.md | Reworks layout (centered hero + badges), updates highlights, adds module status column, adds runtime note. |
| package.json | Bumps version to 1.11.1; updates package description; bumps dev deps. |
| llms.txt | Updates LLM repo summary messaging/version; adds maturity section. |
| docs/index.md | Updates docs home hero messaging and a feature description line. |
| docs/guide/view.md | Tweaks security guidance wording about expression sources. |
| docs/guide/getting-started.md | Expands intro with positioning + “where to start” + stability notes. |
| docs/guide/faq.md | Updates “What is bQuery.js?” and adoption-path wording. |
| docs/definition.md | Updates tagline/mission phrasing and core principle label. |
| docs/.vitepress/config.ts | Updates VitePress site description metadata. |
| CHANGELOG.md | Adds 1.11.1 entry describing tooling/dev-dependency updates. |
| bun.lock | Updates lockfile to reflect bumped dev deps and transitive changes (incl. rolldown/postcss). |
| AGENT.md | Updates identity/version/messaging; adds Positioning + Module Maturity sections. |
| .github/copilot-instructions.md | Updates Copilot guidance messaging and module descriptions; bumps baseline mention. |
| .cursorrules | Updates Cursor rules messaging/baseline; adjusts runtime/tooling wording. |
| .clinerules | Updates Cline rules messaging/baseline; clarifies 1.11.1 as patch release. |
Comments suppressed due to low confidence (2)
AGENT.md:47
- The section title says "Version 1.11.1 Highlights", but the bullets describe features introduced in 1.11.0 (server/SSR entry points, etc.). Since this PR states 1.11.1 is a dev-dependency-only patch release, this heading/content pairing is misleading. Consider either renaming the section back to 1.11.0, or rewriting the 1.11.1 highlights to reflect the patch nature (and keep 1.11.0 feature highlights in their own section).
## Version 1.11.1 Highlights
- `@bquery/bquery/server` is now a first-class public entry point for dependency-free backend routing, SSR-aware `render()` responses, repeated-query parsing, and runtime-agnostic WebSocket session handling through `createServer()`.
- `@bquery/bquery/ssr` now spans runtime-agnostic sync/async/streaming rendering with `renderToStringAsync()`, `renderToStream()`, `renderToResponse()`, DOM-free fallback rendering, `createSSRContext()`, head/asset managers, runtime adapters, route loaders, store snapshots, mismatch checks, and resumability hooks.
- The `1.10.0` concurrency helpers and the `1.9.0` watcher/view/media additions remain first-class public APIs; keep them visible in docs and AI guidance instead of treating them as historical footnotes.
.github/copilot-instructions.md:37
- This section is labeled "Version 1.11.1 highlights" but lists the SSR/server feature additions that were introduced in 1.11.0. If 1.11.1 is a patch release with dev-dependency bumps only, the heading should either remain 1.11.0 or the bullets should be updated to reflect what changed in 1.11.1.
## Version 1.11.1 highlights
- `@bquery/bquery/server` is now a first-class public entry point; repo guidance should treat `createServer()` and the runtime-agnostic WebSocket session helpers as part of the documented surface.
- `@bquery/bquery/ssr` now includes runtime-agnostic async/streaming rendering (`renderToStringAsync()`, `renderToStream()`, `renderToResponse()`), DOM-free fallback rendering, `createSSRContext()`, runtime adapters, snapshots, and resumability helpers.
- The `1.10.0` concurrency additions plus the `1.9.0` watcher/view/media APIs remain first-class public surface and should still appear in documentation refreshes.
![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
🧹 Nitpick comments (2)
README.md (1)
18-18: ⚡ Quick winClarify the version notice for 1.11.1 release.
This notice still references "New in 1.11.0" features, but the package version is now 1.11.1. According to
.clinerules, version 1.11.1 is a patch release with dev-dependency updates only. Consider either:
- Updating the notice to "New in 1.11" to cover both releases, or
- Adding a separate "Latest (1.11.1)" notice mentioning the dev-dependency updates
This will help users understand what's new in the current release versus the last feature release.
🤖 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 `@README.md` at line 18, The release note in README.md still says "New in 1.11.0" but the package is 1.11.1; update the notice to avoid misleading users by either changing the header string "New in 1.11.0" to a neutral "New in 1.11" or add a new short "Latest (1.11.1)" paragraph describing that 1.11.1 is a patch with dev-dependency updates only; edit the exact string "New in 1.11.0" in README.md to implement one of these two options and ensure the new text clearly states the scope of the 1.11.1 changes.docs/index.md (1)
47-49: ⚡ Quick winClarify the version notice for 1.11.1 release.
Similar to the README, this section still highlights "New in 1.11.0" but the current release is 1.11.1 (a patch with dev-dependency updates only). Consider updating to "New in 1.11" or adding a brief note about 1.11.1 for consistency with the actual release version.
🤖 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 `@docs/index.md` around lines 47 - 49, Update the release header and note in docs/index.md: change the heading text "## New in 1.11.0" to a more accurate, version-agnostic label like "## New in 1.11" (or "## New in 1.11.1" plus a brief parenthetical noting it's a patch with dev-dependency updates only) so it matches the current release; edit the paragraph under that header (the runtime-agnostic SSR sentence and references to `@bquery/bquery/server` and `1.10.0`) to include a one-line parenthetical mentioning the 1.11.1 patch status if you choose the explicit 1.11.1 header.
🤖 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 `@docs/guide/getting-started.md`:
- Line 5: Update the intro sentence that begins "bQuery.js is a
batteries-included TypeScript framework..." to tighten the compound modifier:
replace "zero mandatory build step" with a clearer hyphenated phrase such as
"zero-build workflow" or "no mandatory build step" (e.g., change the fragment to
"a zero-build workflow" or "no mandatory build step") and ensure surrounding
punctuation/spacing reads smoothly in that sentence.
---
Nitpick comments:
In `@docs/index.md`:
- Around line 47-49: Update the release header and note in docs/index.md: change
the heading text "## New in 1.11.0" to a more accurate, version-agnostic label
like "## New in 1.11" (or "## New in 1.11.1" plus a brief parenthetical noting
it's a patch with dev-dependency updates only) so it matches the current
release; edit the paragraph under that header (the runtime-agnostic SSR sentence
and references to `@bquery/bquery/server` and `1.10.0`) to include a one-line
parenthetical mentioning the 1.11.1 patch status if you choose the explicit
1.11.1 header.
In `@README.md`:
- Line 18: The release note in README.md still says "New in 1.11.0" but the
package is 1.11.1; update the notice to avoid misleading users by either
changing the header string "New in 1.11.0" to a neutral "New in 1.11" or add a
new short "Latest (1.11.1)" paragraph describing that 1.11.1 is a patch with
dev-dependency updates only; edit the exact string "New in 1.11.0" in README.md
to implement one of these two options and ensure the new text clearly states the
scope of the 1.11.1 changes.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 0101adce-0696-4ecb-b7f9-84c77cea2cbb
⛔ Files ignored due to path filters (1)
bun.lockis excluded by!**/*.lock
📒 Files selected for processing (17)
.clinerules.cursorrules.github/copilot-instructions.mdAGENT.mdCHANGELOG.mdREADME.mddocs/.vitepress/config.tsdocs/definition.mddocs/guide/faq.mddocs/guide/getting-started.mddocs/guide/view.mddocs/index.mdllms.txtpackage.jsonsrc/index.tsvite.config.tsvite.umd.config.ts
Collaborator
Author
|
@copilot apply changes based on the comments in this thread |
Contributor
Done in commit
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request updates project documentation and metadata to reflect the 1.11.1 patch release of bQuery.js, clarifies its positioning as a full-stack TypeScript web framework (not just a DOM utility library), and improves module descriptions and project highlights. No public API changes or code changes are introduced; all updates are to documentation, repo guidance, and dev dependencies.
Release and Positioning Updates:
1.11.0to1.11.1in documentation and repo guidance files, and clarified that 1.11.1 is a patch release with only dev-dependency updates. [1] [2] [3] [4] [5] [6] [7] [8]Documentation and Guidance Improvements:
AGENT.md,.github/copilot-instructions.md), including maturity levels (Stable, Beta, Experimental) and more detailed summaries of each module's purpose. [1] [2]AGENT.mdto distinguish bQuery.js from jQuery and other frameworks, and referenced this section in the design principles. [1] [2]Changelog and Versioning:
CHANGELOG.md, documenting that this release only updates development dependencies (@typescript-eslint,eslint,globals,vite, androlldown). [1] [2]Tooling and Runtime Support:
These changes ensure that all documentation and project guidance accurately reflect the project's current positioning, version, and supported workflows, and that new users understand bQuery.js as a full-stack framework, not just a DOM utility.
Summary by CodeRabbit
Chores
Documentation