Skip to content

Improve documentation discoverability for coding agents#388

Merged
YusukeIwaki merged 1 commit into
mainfrom
codex/improve-documentation-discoverability
Jul 24, 2026
Merged

Improve documentation discoverability for coding agents#388
YusukeIwaki merged 1 commit into
mainfrom
codex/improve-documentation-discoverability

Conversation

@YusukeIwaki

Copy link
Copy Markdown
Owner

Summary

  • generate a root /llms.txt index and Markdown endpoints for the Docusaurus documentation
  • add concise descriptions and Ruby-specific usage guidance for coding agents
  • publish documentation, source code, and bug tracker URLs through RubyGems metadata

Motivation

Addresses #387.

The gem already includes its Markdown documentation, but the documentation website did not expose an LLM-friendly index or raw Markdown endpoints, and the published gem did not declare its documentation URL through RubyGems metadata.

Verification

  • cd documentation && yarn build
  • confirmed generation of build/llms.txt and build/docs/article/getting_started.md
  • confirmed local HTTP responses use text/plain for /llms.txt and text/markdown for Markdown endpoints
  • rbenv exec ruby -c playwright.gemspec
  • built the gem and inspected its metadata and packaged documentation
  • git diff --check

The Docusaurus build still reports the existing generated-documentation warning for the request#navigation_request? anchor; it does not fail the build.

@vercel

vercel Bot commented Jul 21, 2026

Copy link
Copy Markdown

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

Project Deployment Actions Updated (UTC)
playwright-ruby-client Ready Ready Preview, Comment Jul 21, 2026 9:08pm

@YusukeIwaki
YusukeIwaki marked this pull request as ready for review July 24, 2026 12:17
@YusukeIwaki
YusukeIwaki merged commit 5953a99 into main Jul 24, 2026
24 of 29 checks passed
@YusukeIwaki
YusukeIwaki deleted the codex/improve-documentation-discoverability branch July 24, 2026 12:18
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