Skip to content

docs: expand AI agent prompts#167

Open
basit3407 wants to merge 6 commits into
mainfrom
codex/ai-agent-prompts
Open

docs: expand AI agent prompts#167
basit3407 wants to merge 6 commits into
mainfrom
codex/ai-agent-prompts

Conversation

@basit3407

@basit3407 basit3407 commented Jun 4, 2026

Copy link
Copy Markdown
Collaborator

Summary:

  • Add the AI Agents docs page and three public agent prompts for JS SDK integration, OAuth/User APIs, and integration review.
  • Add .well-known agent skill and prompt discovery metadata.
  • Update the docs sidebar and llms.txt so agents can discover the new resources.

Scope note:

Local validation:

  • Node 22 yarn test passed: 120 tests.
  • yarn typecheck
  • yarn llms:sync
  • npx docusaurus build
  • yarn re-gen, then generated API churn restored/cleaned
  • yarn postbuild:seo

@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Jun 4, 2026

Copy link
Copy Markdown

Deploying qf-api-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 72ab2f3
Status: ✅  Deploy successful!
Preview URL: https://109b5b68.qf-api-docs.pages.dev
Branch Preview URL: https://codex-ai-agent-prompts.qf-api-docs.pages.dev

View logs

@basit3407

Copy link
Copy Markdown
Collaborator Author

Follow-up for the Codex plugin repo publication: #168. The local plugin is committed at C:\Code\qf-agent-tools, but GitHub rejected repo creation because basit3407 lacks org CreateRepository permission.

@basit3407 basit3407 marked this pull request as ready for review June 4, 2026 05:51
@basit3407

Copy link
Copy Markdown
Collaborator Author

Scope correction: response-example OpenAPI changes have been removed from this PR and split into focused PRs: Content #169, Search #170, OAuth #171, and User #172. This PR is now limited to AI-agent docs/prompts/discovery files.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Adds an “AI Agents” documentation entry point plus new public agent prompts and .well-known discovery metadata so coding agents can locate Quran Foundation scaffolding/integration/review guidance.

Changes:

  • Adds a new docs page at docs/ai-agents/index.mdx and links it into the Docusaurus sidebar.
  • Publishes three new agent prompt markdown files and registers them in static/.well-known/agent-prompts/index.json (and updates tests accordingly).
  • Updates .well-known agent-skill documentation + indexes, and syncs static/llms.txt to include additional discoverable docs links.

Reviewed changes

Copilot reviewed 10 out of 10 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
tests/agent-prompts.test.cjs Extends coverage to assert new prompt IDs/URLs are published.
static/llms.txt Adds additional discoverability links (including the new AI Agents page).
static/agent-prompts/qf-review-existing-integration.md New public prompt for auditing an existing integration.
static/agent-prompts/qf-oauth-user-apis.md New public prompt for OAuth2/OIDC + signed-in User API flows.
static/agent-prompts/qf-js-sdk-integration.md New public prompt for safely integrating @quranjs/api.
static/.well-known/agent-skills/quran-foundation-api-docs/SKILL.md Expands canonical sources + routing hints to include new prompts/AI Agents page.
static/.well-known/agent-skills/index.json Updates skill digest to reflect SKILL.md changes.
static/.well-known/agent-prompts/index.json Registers new prompts in the published prompt registry JSON.
sidebars.js Adds “AI Agents” into the shared docs sidebar.
docs/ai-agents/index.mdx New “AI Agents” landing page with CLI commands, safety notes, and prompt links.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread tests/agent-prompts.test.cjs
Comment thread static/llms.txt
@basit3407 basit3407 requested a review from osamasayed June 4, 2026 11:07
@osamasayed

Copy link
Copy Markdown
Member

@codex review

@chatgpt-codex-connector

Copy link
Copy Markdown

Codex Review: Didn't find any major issues. Delightful!

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

@basit3407

Copy link
Copy Markdown
Collaborator Author

@osamasayed Should we merge this one ?

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.

3 participants