Skip to content

Add hidden POC onboarding page - #7066

Open
DeweyMarco wants to merge 2 commits into
mainfrom
poc-onboarding-guide
Open

Add hidden POC onboarding page#7066
DeweyMarco wants to merge 2 commits into
mainfrom
poc-onboarding-guide

Conversation

@DeweyMarco

@DeweyMarco DeweyMarco commented Aug 24, 2026

Copy link
Copy Markdown
Contributor

What changed

Adds poc-onboarding.mdx at the repo root: a self-serve setup guide for enterprise customers running a Mintlify proof of concept.

Eight steps, from creating the account and connecting their own GitHub repo through to a results review. The content is derived from the SE working session guides in the internal KB (kb.mintlify.com/sales/se/working-sessions/*), so the customer-facing instructions and the SE-led sessions teach the same mechanics.

Rationale

Sales needs a single link to send enterprise prospects at POC kickoff. The audience is mostly non-technical, so every step names who from their team is needed, for how long, and what to do at the common blockers.

Corrections the working sessions surfaced

  • Authentication requires a custom domain or a *.mintlify.app subdomain. It does not work on the default .mintlify.site URL or on a custom basepath. The first draft treated the custom domain as skippable during a POC and auth as independent of it, which would have sent customers into a wall in their final week. Now flagged in step 1 and again in step 7.
  • Dashboard SSO and site authentication are different things — who logs into the dashboard vs who can read the docs. Now split, with the real method taxonomy (password / Mintlify-managed / OAuth 2.0 / JWT) and the two-account test that actually proves group gating works.

Substantive additions

  • The repo / dashboard / live-site model up front, which is the framing non-technical readers need before any of the steps make sense.
  • Step 4 rewritten with the real editor flow (branch selector, / menu, the eye and </> toggles, preview links), plus the objection that matters most to engineering stakeholders: publishing writes a Git commit, so CODEOWNERS, required reviews, and branch protection all still apply.
  • Step 5 gets the actual docs.json theme keys, the light/dark check including currentColor SVGs, and the OG image.
  • Step 6 gets the three-way answer check (did it answer, was it right, which page did it cite), the point that frontmatter description is the biggest lever on retrieval, both MCP servers and who each serves, the contextual menu, and automations.
  • Sample content now chosen from top pages by traffic rather than intuition, plus the two navigation tests and Notion/Confluence sync as a third migration route.
  • Success criteria reframed as one lever (acquisition / deflection / retention), one metric, and a recorded baseline.

Hidden-page mechanics

Not listed in docs.json, and carries noindex: true in frontmatter. Per organize/hidden-pages.mdx, omitting a page from docs.json keeps it out of the sidebar, site search, AI assistant context, llms.txt, and the sitemap — but no noindex meta tag is emitted, so a crawler that finds the URL elsewhere can still index it. noindex: true supplies the tag. Same treatment as enterprise-contracting.mdx and migration-services/go-live-checklist.mdx.

Step 7 uses this page itself as the worked example of "hidden is not private."

Verification

  • mint broken-links and mint a11y — both clean. Confirmed the link checker does scan pages outside docs.json by temporarily breaking a link and seeing it reported.
  • Rendered locally and checked visually: Columns at 2 and 3 up, Steps, nested Accordion, AccordionGroup, Tabs, titled JSON code blocks, and all four tables.
  • All cross-page anchors verified against the target files' headings.
  • vale not run — not installed locally.

Areas of uncertainty

  1. The migration tab in step 3 says to ask your Mintlify contact whether a migration is included in the POC, rather than promising one. If POC migrations are in fact standard, state it outright.
  2. The two-to-three week timeline is my estimate from the step contents, not from real POC data.
  3. I left the Forrester deflection benchmarks out. The leading-brands-value-from-docs session carries them (~25–30% for a maintained KB, 35–45% with contextual guidance) with a warning that they're directional third-party figures. They're useful for setting a target, but quoting them in customer-facing docs invites scrutiny, so the page tells customers to baseline their own ticket volume instead. Easy to add back if you'd rather have the numbers.

Also worth confirming the page belongs at the root rather than under migration-services/, where the other two hidden enterprise pages live.

🤖 Generated with Claude Code

Adds poc-onboarding.mdx, a self-serve setup guide for enterprise
customers running a Mintlify proof of concept. Covers account and
repository setup, inviting the team, migrating sample content,
publishing a first change, branding, the AI assistant, SSO and
security, and a results review.

Written for non-technical readers, with each step naming who from
their team is needed and for how long.

The page is not listed in docs.json and carries noindex: true, so it
is reachable by direct URL only. This matches enterprise-contracting
and migration-services/go-live-checklist.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@mintlify

mintlify Bot commented Aug 24, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
mintlify 🟢 Ready View Preview Aug 24, 2026, 7:26 PM

@mintlify

mintlify Bot commented Aug 24, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
tomee 🟡 Building Aug 24, 2026, 7:24 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

Pulls the mechanics, prerequisites, and objection-handling from the
internal SE working sessions into the customer-facing steps.

Corrections:
- Authentication requires a custom domain or *.mintlify.app subdomain
  and does not work on .mintlify.site or a custom basepath. The page
  previously treated the custom domain as skippable during a POC and
  auth as independent of it. Now flagged in step 1 and step 7.
- Separates dashboard SSO (who logs in) from site authentication (who
  reads), with the real method taxonomy and the two-account test.

Additions:
- The repo/dashboard/live-site model up front.
- Step 4 rewritten with the actual editor flow, plus the point that
  publishing writes a Git commit so CODEOWNERS and branch protection
  still apply.
- Step 5 gets the docs.json theme keys, the light/dark check, and OG.
- Step 6 gets the three-way answer check (answered, correct, which
  page cited), the description-quality lever, both MCP servers, the
  contextual menu, and automations.
- Sample content chosen from top pages by traffic; two navigation
  tests; Notion and Confluence sync as a third migration route.
- Success criteria reframed as one lever and one metric with a
  recorded baseline.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.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.

1 participant