docs(readme): improve SEO/AEO discoverability and time-to-first-success - #62
Open
EduPav wants to merge 1 commit into
Open
docs(readme): improve SEO/AEO discoverability and time-to-first-success#62EduPav wants to merge 1 commit into
EduPav wants to merge 1 commit into
Conversation
Concentrate the highest-value keywords in the zones crawlers and answer engines weight most (H1 area + first paragraph), and fix a time-to-first- success snag in Quick Start. - Add a keyword-rich subtitle and a badge row under the H1 (Next.js 16, FastAPI, Backblaze B2 / S3-compatible). - Rewrite the opening paragraph answer-first: it now leads with a self-contained definition instead of a slogan (better AEO snippet), and keeps the "stop wiring boilerplate" hook as the follow-on. - Move the project-page/integrations link paragraph below "What you get". - Reorder Quick Start: "Supported local environments" now sits after the setup steps instead of blocking the path to first run. - Add a "Why Backblaze B2?" section (S3-compatible drop-in, data-heavy economics, free to start) — question-shaped content with AEO value. - Surface a one-click Vercel deploy CTA near the screenshots. - Trim the Commands section to the day-to-day set (still naming every command check:agent-docs requires) and point deep reference at docs/dev-workflows.md. - Reframe the trailing skill link as "Related projects". All new B2 links reuse the existing utm_content token; pnpm check:agent-docs passes (109 checks).
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
1 participant
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.
What this changes
README-only edits that concentrate the highest-value keywords where crawlers and answer engines weight them most (H1 area + first paragraph), improve time-to-first-success, and add question-shaped content that answer engines extract. No code or behavior changes.
Based on a critical SEO/AEO review of the README. Prioritized so the high-leverage items are grouped first.
High leverage
Next.js 16 + FastAPI,Backblaze B2 (S3-compatible), in the most-indexed zone (previously absent until ~line 199).Supported local environments(WSL2/EPERM/IPv6 caveats) moved below the start + setup steps, so nothing blocks the path to first run.Medium / low
docs/dev-workflows.md).Guardrails
pnpm check:agent-docspasses (109 checks). The trimmed Commands section still names every command the check requires, and all B2 links reuse the existingutm_contentattribution token, so the branding check stays green.Not included (from the review, for a separate decision)
Next.js/FastAPI/S3-compatible— same keyword gap as the old H1, but they're repo settings, not files, so they can't ride in this PR.