Skip to content

fix(docs): SEO hygiene for docs.keyway.sh (robots.txt, titles, descriptions) - #25

Merged
NicolasRitouet merged 1 commit into
mainfrom
seo/docs-seo-fixes
Jul 6, 2026
Merged

fix(docs): SEO hygiene for docs.keyway.sh (robots.txt, titles, descriptions)#25
NicolasRitouet merged 1 commit into
mainfrom
seo/docs-seo-fixes

Conversation

@NicolasRitouet

@NicolasRitouet NicolasRitouet commented Jul 4, 2026

Copy link
Copy Markdown
Member

Contexte

Suite de l'audit SEO du 04/07 (rapports dans keyway-landing seo/). Quatre correctifs d'hygiène sur le site docs, vérifiés dans le build Docusaurus.

Changements

  1. static/robots.txt (nouveau) : docs.keyway.sh/robots.txt renvoyait un 404 — le sitemap docs n'était déclaré nulle part. Ajout avec Sitemap: https://docs.keyway.sh/sitemap.xml.
  2. /ai-agents : title → « Use Secrets with Claude Code, Cursor & Copilot (MCP) » + description. Données GSC : 425 impressions à position ~19,7 sur le cluster « prevent claude/cursor/copilot from reading .env » ; l'ancien title (« AI Agents ») ne matchait aucune requête. Le label de sidebar reste « AI Agents ».
  3. /api : ajout d'une description: — Docusaurus émettait « Authentication » (premier heading) comme meta description.
  4. intro.md : lien upgrade → app.keyway.sh/settings (l'ancien keyway.sh/settings était un 404 ; un redirect a aussi été ajouté côté landing dans keywaysh/keyway-landing#13).

Vérification

Build Docusaurus vert. Contrôlé dans build/ : robots.txt servi, titles/descriptions corrects sur les deux pages, lien settings mis à jour.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Updated the AI Agents page title, sidebar label, and description for clearer navigation and context.
    • Added an API Reference description summarizing the coverage of key endpoints.
    • Fixed the upgrade link in the Plans section to point to the correct settings page.
    • Added a robots policy for the documentation site and sitemap discovery.

- Add static/robots.txt with sitemap pointer (robots.txt was a 404, so the
  docs sitemap was never declared to crawlers)
- Retitle /ai-agents to "Use Secrets with Claude Code, Cursor & Copilot (MCP)"
  and add a description; the page has 425 GSC impressions at position ~19.7
  and the old title ("AI Agents") matched none of the queries. Sidebar label
  stays "AI Agents"
- Add a description to /api (Docusaurus was emitting the first heading,
  "Authentication", as the meta description)
- Point the upgrade link at app.keyway.sh/settings (keyway.sh/settings was
  a 404 until the redirect added in keyway-landing#13)

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@vercel

vercel Bot commented Jul 4, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

1 Skipped Deployment
Project Deployment Actions Updated (UTC)
keyway-dashboard Skipped Skipped Jul 4, 2026 4:07pm

Request Review

@coderabbitai

coderabbitai Bot commented Jul 4, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 5f3bacc9-df87-41f5-8c49-d751f8a69a1f

📥 Commits

Reviewing files that changed from the base of the PR and between c9911f8 and 472b38f.

📒 Files selected for processing (4)
  • packages/docs/docs/ai-agents.md
  • packages/docs/docs/api.md
  • packages/docs/docs/intro.md
  • packages/docs/static/robots.txt

📝 Walkthrough

Walkthrough

Documentation frontmatter updates for ai-agents.md (title, sidebar metadata, description) and api.md (description), an upgrade link URL correction in intro.md, and a new robots.txt file added for the docs site.

Changes

Documentation and Static Assets

Layer / File(s) Summary
Doc page metadata and link fix
packages/docs/docs/ai-agents.md, packages/docs/docs/api.md, packages/docs/docs/intro.md
Frontmatter title, sidebar position/label, and description fields updated for the AI Agents and API Reference pages; the Plans section upgrade link now points to app.keyway.sh/settings.
New robots.txt
packages/docs/static/robots.txt
Adds a robots.txt allowing all crawlers to access the site root and pointing to the sitemap.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Possibly related PRs

  • keywaysh/keyway#3: Also modifies packages/docs/docs/ai-agents.md frontmatter/content, overlapping directly with this PR's changes to the same file.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly matches the docs SEO-focused changes: robots.txt, page titles, and descriptions.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch seo/docs-seo-fixes

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@NicolasRitouet
NicolasRitouet merged commit 6f99ed9 into main Jul 6, 2026
5 checks passed
@NicolasRitouet
NicolasRitouet deleted the seo/docs-seo-fixes branch July 6, 2026 04:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant