docs: expand AI agent prompts#167
Conversation
Deploying qf-api-docs with
|
| 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 |
|
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. |
There was a problem hiding this comment.
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.mdxand 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-knownagent-skill documentation + indexes, and syncsstatic/llms.txtto 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.
|
@codex review |
|
Codex Review: Didn't find any major issues. Delightful! ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
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". |
|
@osamasayed Should we merge this one ? |
Summary:
.well-knownagent skill and prompt discovery metadata.llms.txtso agents can discover the new resources.Scope note:
Local validation:
yarn testpassed: 120 tests.yarn typecheckyarn llms:syncnpx docusaurus buildyarn re-gen, then generated API churn restored/cleanedyarn postbuild:seo