Skip to content

WIP: Improve docs metadata and SEO#768

Open
rodincave wants to merge 9 commits into
mainfrom
codex/docs-metadata-seo
Open

WIP: Improve docs metadata and SEO#768
rodincave wants to merge 9 commits into
mainfrom
codex/docs-metadata-seo

Conversation

@rodincave
Copy link
Copy Markdown
Contributor

@rodincave rodincave commented May 13, 2026

Summary

  • Apply documentation manifesto casing and terminology updates across docs pages
  • Improve MDX frontmatter so docs pages have unique, specific SEO titles and descriptions
  • Prefer MCP Apps views wording in API reference metadata
  • Fix typos and grammar issues found during the docs pass, including GitHub, VS Code, HTTP article usage, and telemetry wording

Validation

  • Custom metadata audit: 67 MDX pages checked, 0 issues
  • pnpm --dir docs lint
  • git diff --check

Notes

  • It looks like a long PR but it's only content!

Greptile Summary

This is a docs-only pass across 67 MDX pages improving SEO metadata and applying consistent terminology and casing rules throughout the Skybridge documentation.

  • Frontmatter metadata: Every page receives a unique, keyword-rich description (and keywords on the two top-level pages) replacing generic one-liners, with no changes to routing or navigation structure.
  • Terminology and casing: "VSCode" → "VS Code", "Github" → "GitHub", "a HTTP" → "an HTTP", "MCP Clients/Servers" → "MCP clients/servers", "Personal identifiable information" → "Personally identifiable information", and sentence-cased headings throughout.
  • Prose polish: Telemetry opt-out instructions are simplified, one word-order fix in telemetry.mdx ("read from and write to"), and a handful of minor grammar improvements across the guides.

Confidence Score: 5/5

Pure documentation content changes with no functional code, no broken links, and no navigation structure modifications — safe to merge.

All 67 changed files are MDX documentation pages. Every change is limited to frontmatter metadata (title, description, keywords) and prose copy — casing fixes, grammar corrections, and terminology standardisation. There is no executable code, no schema changes, and no routing or sidebar structure touched.

No files require special attention.

Prompt To Fix All With AI
Fix the following 1 code review issue. Work through them one at a time, proposing concise fixes.

---

### Issue 1 of 1
docs/telemetry.mdx:73
Using the singular "environment variable" when listing two distinct variables is mildly ambiguous — a reader could interpret it as needing to set both rather than choosing one. The previous plural form was clearer.

```suggestion
- setting the `SKYBRIDGE_TELEMETRY_DISABLED=1` or `DO_NOT_TRACK=1` environment variables
```

Reviews (2): Last reviewed commit: "Apply suggestions from code review" | Re-trigger Greptile

@rodincave rodincave force-pushed the codex/docs-metadata-seo branch from f8d2f8c to d0f9d52 Compare May 13, 2026 20:47
@rodincave rodincave requested review from harijoe and paulleseute May 13, 2026 21:09
@rodincave rodincave self-assigned this May 13, 2026
@rodincave rodincave marked this pull request as ready for review May 13, 2026 21:12
---
title: useOpenExternal
description: "Navigate users to external URLs properly from within your app views."
description: "Open external URLs safely from MCP Apps views with host-aware navigation for ChatGPT Apps, MCP Apps, embedded UI, and user workflows."
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I don't really get what host-aware means, neither embedded UI, and user workflows

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

yea this one was a bit hallucinated!

Open external URLs safely from inside your MCP Apps views

Better?

---
title: useDisplayMode
description: "Read and control view display modes: inline, fullscreen, or picture-in-picture."
description: "Read and control MCP Apps view display modes such as inline, fullscreen, and picture-in-picture across supported MCP clients and AI hosts."
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

AI hosts ?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

yes we can remove the AI hosts

Read and control MCP Apps view display modes such as inline, fullscreen, and picture-in-picture across supported MCP clients.

Comment thread docs/api-reference/use-apps-sdk-context.mdx Outdated
---
title: registerTool
description: "Register an MCP tool — with or without a React view"
description: "Register MCP tools in Skybridge, bind them to React views, configure tool metadata, and return structured content for AI hosts and MCP clients."
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I'm not sure about the ai hosts terminology

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Register MCP tools in Skybridge, bind them to React view ressources, configure tool metadata, and return structured content for MCP clients.
?

Comment thread docs/api-reference/infer-utility-types.mdx Outdated
Comment thread docs/api-reference/cli.mdx Outdated
Comment thread docs/api-reference/use-request-close.mdx Outdated
Co-authored-by: Julien Vallini <vallinij@gmail.com>
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.

2 participants