Skip to content

docs: repo-wide messaging update — README header redesign, centred layout, updated branding - #90

Merged
JosunLP merged 9 commits into
devfrom
copilot/update-bquery-rebranding
May 12, 2026
Merged

docs: repo-wide messaging update — README header redesign, centred layout, updated branding#90
JosunLP merged 9 commits into
devfrom
copilot/update-bquery-rebranding

Conversation

Copilot AI commented May 12, 2026

Copy link
Copy Markdown
Contributor

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

  • Centre-aligned the full header block — converted to pure HTML (<h1>, <p>, <a><img/></a>) so CommonMark/GitHub renders correctly inside <div align="center">
  • Logo-first ordering — <img> at 80px above the <h1>, matching standard visual hierarchy
  • Pitch before metadata — tagline and description moved immediately after the title, before badges
  • Badge consolidation — two logical rows separated by <br/>:
    • Row 1: npm version · bundle size · license
    • Row 2: stars · open issues · CodeFactor · jsDelivr
  • Badge accessibility — descriptive alt text on all badge images (e.g. "npm version" instead of "npm")
  • Removed the circular "Repo" badge (reader is already on the repo) and the content-free "unpkg-browse" badge
  • --- separator between the header block and the release callout / Highlights body
  • VitePress metadatadocs/.vitepress/config.ts description updated to match the new tagline
  • Build banners — old slogan replaced in src/index.ts, vite.config.ts, and vite.umd.config.ts so generated bundles ship consistent branding
  • llms.txt runtime metadata — Runtime bullet expanded from Browser (ESM, UMD, IIFE) to include Node.js >=24.0.0 · Bun >=1.3.13 to reflect SSR/server runtime support

@JosunLP
JosunLP marked this pull request as ready for review May 12, 2026 08:39
Copilot AI review requested due to automatic review settings May 12, 2026 08:39
@github-actions github-actions Bot added docs Changes to the documentation build Changes to the build and meta files github Changes to the github meta data files labels May 12, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread README.md Outdated
Comment thread docs/index.md

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 13 out of 13 changed files in this pull request and generated 4 comments.

Comment thread package.json
Comment thread package.json
Comment thread llms.txt
Comment thread README.md Outdated
@JosunLP

JosunLP commented May 12, 2026

Copy link
Copy Markdown
Collaborator

@copilot apply changes based on the comments in this thread

Copilot AI commented May 12, 2026

Copy link
Copy Markdown
Contributor Author

@copilot apply changes based on the comments in this thread

Done in 4c830f8. Applied all four items from the review thread:

  • README.mdalt="npm"alt="npm version" for better screen-reader clarity
  • src/index.ts, vite.config.ts, vite.umd.config.ts — build banner/JSDoc comment updated from the old slogan ("The jQuery for the Modern Web Platform") to the current tagline ("The full-stack web framework that speaks jQuery.")
  • llms.txt — Runtime bullet expanded from Browser (ESM, UMD, IIFE) to Browser (ESM, UMD, IIFE) · Node.js >=24.0.0 · Bun >=1.3.13

(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
@JosunLP
JosunLP requested a review from Copilot May 12, 2026 09:23

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 16 out of 16 changed files in this pull request and generated 4 comments.

Comment thread AGENT.md Outdated
Comment thread llms.txt Outdated
Comment thread .cursorrules Outdated
Comment thread src/index.ts Outdated
Co-authored-by: Copilot Autofix powered by AI <[email protected]>
Signed-off-by: Jonas Pfalzgraf <[email protected]>
Copilot AI review requested due to automatic review settings May 12, 2026 09:37
JosunLP and others added 2 commits May 12, 2026 11:37
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]>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 16 out of 16 changed files in this pull request and generated no new comments.

@JosunLP
JosunLP merged commit 990133f into dev May 12, 2026
7 checks passed
@JosunLP
JosunLP deleted the copilot/update-bquery-rebranding branch May 12, 2026 09:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

build Changes to the build and meta files docs Changes to the documentation github Changes to the github meta data files

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants