Skip to content

Add Connected Apps documentation#179

Open
basit3407 wants to merge 7 commits into
mainfrom
codex/connected-apps-docs
Open

Add Connected Apps documentation#179
basit3407 wants to merge 7 commits into
mainfrom
codex/connected-apps-docs

Conversation

@basit3407

Copy link
Copy Markdown
Collaborator

Summary

  • Add a production-ready Connected Apps docs page at /docs/connected-apps/ for app builders, app owners, and partners.
  • Integrate the page into the navbar, shared docs sidebars, llms.txt discovery, and the MCP server card resources.
  • Add regression coverage for page front matter, production concepts, navigation, discovery, responsive styling, and MCP resource metadata.

Details

  • Reworked the prototype into native Docusaurus MDX instead of carrying over standalone HTML or mock branding.
  • Clarifies the relationship between Quran.com/apps, listing packages, review criteria, visibility paths, user-facing disclosures, responsible use, and re-review triggers.
  • Removes internal-facing language from the guide and frames ownership, endorsement, labels, data use, ads, donations, AI features, and material changes for external partners.
  • Fixes the Windows yarn test script by using node --test tests.
  • Removes an invalid sidebarId prop from the APIs dropdown to avoid React DOM warnings.

Validation

  • yarn test passed: 136/136
  • yarn typecheck passed
  • npx docusaurus build passed
  • yarn postbuild:seo passed
  • Served production HTML for /docs/connected-apps/ returned HTTP 200 and no longer contained the internal/mock phrases flagged during review.

@basit3407 basit3407 changed the title [codex] Add Connected Apps documentation Add Connected Apps documentation Jun 29, 2026
@basit3407 basit3407 marked this pull request as ready for review June 29, 2026 01:19
@basit3407 basit3407 requested a review from Copilot June 29, 2026 01:19

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 a production “Connected Apps” documentation page and wires it into the site’s navigation and machine-discovery surfaces (llms.txt + MCP server card), with regression tests to keep the integration stable.

Changes:

  • Add /docs/connected-apps/ page content plus scoped styling for the new guide.
  • Integrate Connected Apps into navbar + shared sidebars, llms.txt generation/static fallback, and MCP server-card resources.
  • Add/extend tests for the new page + discovery metadata; adjust yarn test to run reliably on Windows.

Reviewed changes

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

Show a summary per file
File Description
tests/mcp-server-card.test.cjs Asserts the MCP server card includes the Connected Apps doc URL.
tests/connected-apps-docs.test.cjs New regression test suite validating the new doc page, nav/sidebar wiring, llms.txt generation, and CSS responsiveness.
static/llms.txt Adds Connected Apps to the static discovery document and adjusts SDK link ordering.
static/.well-known/mcp/server-card.json Adds a Connected Apps resource entry for MCP discovery.
src/css/custom.css Adds scoped styling rules for the Connected Apps guide.
sidebars.js Adds the Connected Apps doc to shared docs sidebars.
plugins/llms-txt-plugin.js Adds Connected Apps to URL priority and header links in generated llms.txt.
package.json Updates test script to node --test tests.
docusaurus.config.js Adds Connected Apps to the navbar and removes an invalid dropdown prop.
docs/connected-apps.mdx New Connected Apps guide content (MDX) with custom layout sections.

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

Comment thread docs/connected-apps.mdx
Comment thread docs/connected-apps.mdx Outdated
Comment thread docs/connected-apps.mdx Outdated
Comment thread docs/connected-apps.mdx Outdated
Comment thread docs/connected-apps.mdx Outdated
Comment thread src/css/custom.css

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 7a5702807c

ℹ️ 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".

Comment thread package.json Outdated
@cloudflare-workers-and-pages

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

Copy link
Copy Markdown

Deploying qf-api-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 4bebfcc
Status: ✅  Deploy successful!
Preview URL: https://ec9164aa.qf-api-docs.pages.dev
Branch Preview URL: https://codex-connected-apps-docs.qf-api-docs.pages.dev

View logs

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

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

Comment thread tests/connected-apps-docs.test.cjs
Comment thread scripts/run-tests.cjs

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

Copilot reviewed 11 out of 11 changed files in this pull request and generated 3 comments.

Comment thread docs/connected-apps.mdx
Comment thread tests/connected-apps-docs.test.cjs
Comment thread scripts/run-tests.cjs
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.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