Add hidden POC onboarding page - #7066
Open
DeweyMarco wants to merge 2 commits into
Open
Conversation
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>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changed
Adds
poc-onboarding.mdxat 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
*.mintlify.appsubdomain. It does not work on the default.mintlify.siteURL 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.Substantive additions
/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.docs.jsontheme keys, the light/dark check includingcurrentColorSVGs, and the OG image.descriptionis the biggest lever on retrieval, both MCP servers and who each serves, the contextual menu, and automations.Hidden-page mechanics
Not listed in
docs.json, and carriesnoindex: truein frontmatter. Perorganize/hidden-pages.mdx, omitting a page fromdocs.jsonkeeps it out of the sidebar, site search, AI assistant context,llms.txt, and the sitemap — but nonoindexmeta tag is emitted, so a crawler that finds the URL elsewhere can still index it.noindex: truesupplies the tag. Same treatment asenterprise-contracting.mdxandmigration-services/go-live-checklist.mdx.Step 7 uses this page itself as the worked example of "hidden is not private."
Verification
mint broken-linksandmint a11y— both clean. Confirmed the link checker does scan pages outsidedocs.jsonby temporarily breaking a link and seeing it reported.Columnsat 2 and 3 up,Steps, nestedAccordion,AccordionGroup,Tabs, titled JSON code blocks, and all four tables.valenot run — not installed locally.Areas of uncertainty
leading-brands-value-from-docssession 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