docs: repo-wide messaging update — README header redesign, centred layout, updated branding - #90
Merged
Merged
Conversation
Agent-Logs-Url: https://github.com/bQuery/bQuery/sessions/36417cf4-1567-4e35-933e-1967051cb11e Co-authored-by: JosunLP <[email protected]>
Agent-Logs-Url: https://github.com/bQuery/bQuery/sessions/36417cf4-1567-4e35-933e-1967051cb11e Co-authored-by: JosunLP <[email protected]>
Agent-Logs-Url: https://github.com/bQuery/bQuery/sessions/ec99796b-19f5-43d8-a7ab-27ecbcc25467 Co-authored-by: JosunLP <[email protected]>
Copilot created this pull request from a session on behalf of
JosunLP
May 12, 2026 08:39
View session
JosunLP
marked this pull request as ready for review
May 12, 2026 08:39
Contributor
There was a problem hiding this comment.
Pull request overview
This PR refreshes bQuery.js positioning and documentation presentation by redesigning the README header, updating taglines/descriptions across repo-facing docs, and introducing module maturity/status messaging for clearer expectations.
Changes:
- Redesigns the README header layout (logo-first, centered block, consolidated badges) and updates highlights/messaging.
- Updates product description/tagline across
package.json, docs homepage/guides, and AI guidance files (AGENT.md,llms.txt, Copilot/Cursor/Cline rules). - Adds explicit module maturity/status information (Stable/Beta/Experimental) in key docs.
Reviewed changes
Copilot reviewed 12 out of 12 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | New centered, logo-first header; updated tagline/pitch; refreshed highlights; adds module status column and runtime note. |
| package.json | Updates npm package description to match new positioning. |
| llms.txt | Updates compact LLM summary + adds module maturity section. |
| docs/index.md | Updates docs homepage hero copy and “Why bQuery” narrative to match new positioning. |
| docs/guide/view.md | Refines security-related wording in view guide conclusion. |
| docs/guide/getting-started.md | Rewrites intro, adds stability/maturity note, and adds “where to start” pointers. |
| docs/guide/faq.md | Updates “What is bQuery.js?” framing and a use-case bullet to match new positioning. |
| docs/definition.md | Updates spec tagline/mission framing and adjusts a core principle entry. |
| AGENT.md | Updates identity block, adds “Positioning” and “Module Maturity” sections. |
| .github/copilot-instructions.md | Updates Copilot guidance wording to reflect “framework” positioning and expands module bullets. |
| .cursorrules | Updates short product description and adds “not a utility library” guidance. |
| .clinerules | Updates short product description and reinforces broader product scope wording. |
Agent-Logs-Url: https://github.com/bQuery/bQuery/sessions/bf9758e7-7f83-4859-8268-37e39e564d03 Co-authored-by: JosunLP <[email protected]>
Collaborator
|
@copilot apply changes based on the comments in this thread |
Agent-Logs-Url: https://github.com/bQuery/bQuery/sessions/7c1febf3-6fb7-472b-bcb8-c99b90cdbc44 Co-authored-by: JosunLP <[email protected]>
Contributor
Author
Done in 4c830f8. Applied all four items from the review thread:
(The PR title/description update is a GitHub metadata change outside the code; that can be edited directly on the PR.) |
Copilot
AI
changed the title
docs: redesign README header — centred, logo-first, grouped badges
docs: repo-wide messaging update — README header redesign, centred layout, updated branding
May 12, 2026
Co-authored-by: Copilot Autofix powered by AI <[email protected]> Signed-off-by: Jonas Pfalzgraf <[email protected]>
Co-authored-by: Copilot Autofix powered by AI <[email protected]> Signed-off-by: Jonas Pfalzgraf <[email protected]>
Co-authored-by: Copilot Autofix powered by AI <[email protected]> Signed-off-by: Jonas Pfalzgraf <[email protected]>
Co-authored-by: Copilot Autofix powered by AI <[email protected]> Signed-off-by: Jonas Pfalzgraf <[email protected]>
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.
The README header was visually noisy and poorly ordered: title before logo, everything left-aligned, nine badges scattered one-per-line, the pitch buried below the badge wall, and a redundant repo self-link included. Additionally, branding strings were inconsistent across the codebase and docs metadata was stale.
Changes
<h1>,<p>,<a><img/></a>) so CommonMark/GitHub renders correctly inside<div align="center"><img>at 80px above the<h1>, matching standard visual hierarchy<br/>:alttext on all badge images (e.g."npm version"instead of"npm")---separator between the header block and the release callout / Highlights bodydocs/.vitepress/config.tsdescriptionupdated to match the new taglinesrc/index.ts,vite.config.ts, andvite.umd.config.tsso generated bundles ship consistent brandingllms.txtruntime metadata — Runtime bullet expanded fromBrowser (ESM, UMD, IIFE)to includeNode.js >=24.0.0 · Bun >=1.3.13to reflect SSR/server runtime support