Add Connected Apps documentation#179
Conversation
There was a problem hiding this comment.
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 testto 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.
There was a problem hiding this comment.
💡 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".
Deploying qf-api-docs with
|
| 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 |
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Summary
/docs/connected-apps/for app builders, app owners, and partners.llms.txtdiscovery, and the MCP server card resources.Details
yarn testscript by usingnode --test tests.sidebarIdprop from the APIs dropdown to avoid React DOM warnings.Validation
yarn testpassed: 136/136yarn typecheckpassednpx docusaurus buildpassedyarn postbuild:seopassed/docs/connected-apps/returned HTTP 200 and no longer contained the internal/mock phrases flagged during review.