Skip to content

[codex] overhaul Mogplex docs structure#38

Merged
charlesrhoward merged 1 commit into
mainfrom
codex/docs-platform-overhaul
May 18, 2026
Merged

[codex] overhaul Mogplex docs structure#38
charlesrhoward merged 1 commit into
mainfrom
codex/docs-platform-overhaul

Conversation

@charlesrhoward
Copy link
Copy Markdown
Contributor

@charlesrhoward charlesrhoward commented May 18, 2026

Summary

  • Reframes the docs IA around platform, capabilities, configuration, integrations, guides, and reference paths instead of a CLI-vs-web split.
  • Adds source-backed pages for quickstart, platform surfaces, agent authoring, repo instructions, slash commands, MCP connections, integrations, troubleshooting, security, support, models, and plans/billing placeholders.
  • Fixes the docs shell/sidebar and theme switcher behavior that caused duplicate active state and bottom control issues.

Validation

  • git diff --check
  • pnpm lint
  • pnpm types:check
  • pnpm build
  • pre-push hooks: lint, types:check, build
  • Playwright smoke: 9 docs routes, expected text present, no console warnings/errors

View in Codesmith
Need help on this PR? Tag @codesmith with what you need.

  • Let Codesmith autofix CI failures and bot reviews

@vercel
Copy link
Copy Markdown

vercel Bot commented May 18, 2026

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

Project Deployment Actions Updated (UTC)
mogplex-docs Ready Ready Preview, Comment May 18, 2026 6:50pm

Request Review

@charlesrhoward charlesrhoward enabled auto-merge (squash) May 18, 2026 18:49
@charlesrhoward charlesrhoward merged commit 358760a into main May 18, 2026
6 checks passed
@charlesrhoward charlesrhoward deleted the codex/docs-platform-overhaul branch May 18, 2026 18:50
Copy link
Copy Markdown

@mogplex mogplex Bot left a comment

Choose a reason for hiding this comment

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

Mogplex PR Review

Status: Attention needed

This is a large, well-structured docs overhaul that reorganizes Mogplex's information architecture around jobs-to-be-done rather than CLI-vs-web surface split. The content is internally consistent and cross-linked. There are no security issues or broken code. I found a handful of real issues worth addressing before merge: one truncated/incomplete page in the diff, one undocumented environment variable introduced without explanation, and several stale or incorrect cross-references within the content.

2 findings were added inline.

Warnings

  • review-and-triage.mdx links to /web/guides/github-mention-routing but the PR routes that under /web/guides/ (content/docs/capabilities/review-and-triage.mdx)
    Line 17 of the new file links to /web/guides/github-mention-routing, which is referenced in many new files. That path is not a new file in this PR — it is an existing page under content/docs/web/guides/. This is fine, but the integrations/index.mdx and several other new pages also reference /integrations/slack, /integrations/vercel, and /integrations/github — all of which ARE new files in this PR. If any of these were missed during the rename/move, links would 404. The PR description confirms a Playwright smoke test over 9 docs routes passed, but it is not clear whether all the new cross-link targets were included in that smoke set. Consider extending the smoke test to cover the new /integrations/*, /platform/*, /capabilities/*, /configure-and-extend/*, /guides/*, and /reference/* routes.

Suggestions

  • web/meta.json adds models page but content/docs/web/models.mdx is truncated in the diff (content/docs/web/models.mdx)
    The diff for this file ends at The default m (patch line 134 of 134 changes), mid-sentence. Like connections-and-mcp.mdx, the full file from the head branch is complete. This is a GitHub patch-viewer truncation artifact, not a real content issue — but since models is now linked in the sidebar via web/meta.json, it is worth confirming the full page renders in the build.
  • $AGENTS_HOME environment variable referenced in custom-slash-commands.mdx without definition (content/docs/configure-and-extend/custom-slash-commands.mdx)
    The 'Where commands live' section lists $AGENTS_HOME/commands/**/*.md as a user-scope command path, but $AGENTS_HOME is not defined or mentioned anywhere else in the docs — including configuration-and-flags.mdx, which documents the full environment variable table. Either $AGENTS_HOME should be added to the env-var table in configuration-and-flags.mdx with a note that it defaults to $MOGPLEX_HOME, or the reference here should be changed to $MOGPLEX_HOME if they are the same variable.
  • Hardcoded date in API Quickstart example response (2026-05-17) (content/docs/web/api/quickstart.mdx)
    The representative branch.working value in the run-start response example reads mogplex/run/2026-05-17/inspect-tests. Hardcoded dates in docs examples age poorly and can confuse readers who see a date in the future (today) or in the past (later). Use a placeholder like <date> or YYYY-MM-DD instead: mogplex/run/YYYY-MM-DD/inspect-tests.

View check run

<Card title="Connection Scope and Overrides" href="/web/guides/connection-scope-and-overrides" />
<Card title="MCP Servers API" href="/web/api/mcp-servers" />
<Card title="Security and Data Handling" href="/reference/security-and-data-handling" />
</Cards>
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Warning: configure-and-extend/connections-and-mcp.mdx diff is truncated mid-sentence

The diff for this file ends mid-sentence: On startup, the CLI can use the remot (patch line ~140 of 140 changes). The full file fetched from the head branch is complete, so the truncation is only in GitHub's patch display — the actual committed file is fine. However it's worth verifying the build renders the complete file, because any line-count mismatch in the patch viewer can hide a real edit that got dropped.

Comment thread next.config.mjs
@@ -9,6 +9,7 @@ const withMDX = createMDX();
/** @type {import('next').NextConfig} */
const config = {
reactStrictMode: true,
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Warning: allowedDevOrigins added to next.config.mjs without explanation

The change adds allowedDevOrigins: ['127.0.0.1'] to Next.js config. This is not mentioned in the PR description, and it's not obviously related to the docs IA overhaul. In Next.js 15, allowedDevOrigins controls which origins can access the dev server without triggering a CORS warning/block, which means it slightly widens development connectivity. This is low-risk in dev, but the value '127.0.0.1' already resolves to localhost — it's unclear whether this was added to fix a specific dev-environment problem or was left in by accident. A comment explaining the reason would prevent future confusion, and it should not appear in production builds.

Copy link
Copy Markdown

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

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: ee5f746657

ℹ️ 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 content/docs/index.mdx
The first useful question is simpler:
<Callout title="Documentation index">
Fetch the complete docs index at [`/llms.txt`](/llms.txt). Use
[`/llms-full.txt`](/llms-full.txt) when you need the full text of every docs
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Point docs index to an existing full-text endpoint

The new callout instructs readers to use /llms-full.txt, but this repository does not define that route (only /llms.txt and /llms.mdx/... are implemented under src/app). Following this guidance currently returns 404, so agents/users trying to consume the “full text of every docs page” from the homepage will fail unless this link is changed to a real endpoint or the route is added.

Useful? React with 👍 / 👎.

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