docs: rewrite README for adopters and SEO-optimize all doc pages - #20
Merged
Conversation
…d Open Graph and Twitter meta tags, and include robots.txt for SEO - Updated titles and descriptions across various documentation pages for clarity and SEO optimization. - Added Open Graph meta tags for better social media sharing, including site name and image URL. - Introduced a robots.txt file to guide search engine indexing. - Included a new og-image.png for enhanced visual representation on social platforms.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR refactors the README from contributor-focused to adopter-focused and comprehensively SEO-optimizes all documentation pages. The primary goal is to improve discoverability through search engines while providing a more user-friendly onboarding experience for developers evaluating the project.
Changes:
- Rewrote README with a Quick Start section (4 steps), consolidated package table, framework SDK examples (React/Vue/Svelte), and migration/CLI guidance
- Rewrote frontmatter
titleanddescriptionfor all 39 doc pages with keyword-rich content targeting developer search queries - Added social meta tags (OG, Twitter) and a keywords meta tag to Astro config; created
og-image.png(1200x630); addedrobots.txtwith sitemap reference
Reviewed changes
Copilot reviewed 45 out of 46 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | Complete rewrite: Quick Start, package table, framework examples, migration, deployment, security model, and specification links |
| docs/astro.config.mjs | Added OG/Twitter meta tags, keywords meta tag, and absolute URL for og:image |
| docs/public/robots.txt | New file allowing all crawlers with sitemap reference |
| docs/src/content/docs/index.mdx | SEO-optimized homepage title and description |
| docs/src/content/docs/quick-start.mdx | SEO-optimized title and description |
| docs/src/content/docs/guides/*.mdx | SEO-optimized title and description for installation, development, manifest, and testing guides |
| docs/src/content/docs/guides/migration/*.mdx | SEO-optimized title and description for migration guides (Vite, CRA, Next.js, overview) |
| docs/src/content/docs/frameworks/*.mdx | SEO-optimized title and description for React, Vue, Svelte, Angular, and Vanilla JS framework guides |
| docs/src/content/docs/deployment/*.mdx | SEO-optimized title and description for Docker (embedded, proxy, compose), Kubernetes, and CI/CD guides |
| docs/src/content/docs/reference/*.mdx | SEO-optimized title and description for SDK, CLI, codemod, gateway endpoints/flags, manifest schema, and adapter API references |
| docs/src/content/docs/spec/*.mdx | SEO-optimized title and description for specification overview, RFC-0001, conformance, and security model |
| docs/src/content/docs/concepts/*.mdx | SEO-optimized title and description for architecture, security model, variable classification, wire format, and hot reload concepts |
| docs/src/content/docs/examples/*.mdx | SEO-optimized title and description for todo app and zero-config examples |
| docs/src/content/docs/contributing.mdx | SEO-optimized title and description for contributing guide |
| docs/.astro/content-modules.mjs | Auto-generated file with reordered import statements (build artifact) |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Summary
titleanddescriptionfrontmatter with keyword-rich content targeting real search queries (e.g. "React runtime environment variables", "Docker frontend config", "migrate from Vite import.meta.env")astro.config.mjs—og:type,og:site_name,twitter:card(summary_large_image), and akeywordsmeta tagog-image.png(1200x630) from the existing dark logo with tagline and site URL — used by social cards on Twitter, LinkedIn, Slack, Discordrobots.txtpointing to the auto-generated sitemapTest plan
cd docs && npm run build)<title>tags)og-image.pngrenders correctly in a social card preview toolsitemap-index.xmlis generated in dist/🤖 Generated with Claude Code