Add hidden POC onboarding page by DeweyMarco · Pull Request #7066 · mintlify/docs · GitHub
Skip to content

Add hidden POC onboarding page - #7066

Merged
DeweyMarco merged 4 commits into
mainfrom
poc-onboarding-guide
Aug 25, 2026
Merged

Add hidden POC onboarding page#7066
DeweyMarco merged 4 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 connecting a repository through to a results review, opening with a workflow table so a reader can see the whole shape before starting. 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 each step names who from the customer's 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 access and documentation access are different things — who logs into the dashboard vs who can read the docs. Now split, with the method list (password / Mintlify-managed / OAuth 2.0 / JWT) and the two-account test that actually proves group gating works.

Notable content

  • The repo / dashboard / live-site model up front, which non-technical readers need before the steps make sense.
  • Step 4 uses the real editor flow, and states that publishing writes a Git commit so CODEOWNERS, required reviews, and branch protection still apply — the objection engineering stakeholders raise first.
  • Step 6 asks readers to score assistant answers on whether the right page was cited, not just whether the answer looked right, and points at frontmatter description when a correct page never gets retrieved.
  • Sample content is chosen from top pages by traffic rather than intuition, with the hard-to-migrate pages called out explicitly.
  • Success is defined as one business goal with a recorded baseline, plus two or three criteria the POC itself can settle.

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

Why one page and not a series

Considered splitting the steps, or the eleven SE workshops, into separate hidden pages. Tested it first: a hidden: true group in docs.json renders its pages with the visible groups in the sidebar and no next/prev pagination, so a reader lands mid-series looking at the main product docs nav with no way forward. Every link between pages would have to be hand-maintained. Combined with the translation pipeline picking up ./**/*.mdx (three extra locale copies per page), a multi-page series belongs in its own deployment rather than here.

Verification

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

Areas of uncertainty

  1. Step 3 says to ask your Mintlify representative whether migration is included in the POC, rather than promising one. If POC migrations are standard, state it outright.
  2. The two-to-three week timeline is an estimate from the step contents, not from real POC data.
  3. The Forrester deflection benchmarks are deliberately omitted. 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. The page tells customers to baseline their own ticket volume instead. Easy to add back with attribution if preferred.

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


Note

Low Risk
Documentation-only addition with no product or config changes; main consideration is ensuring the page stays unlisted and noindex as intended for a sales-only link.

Overview
Adds a new poc-onboarding.mdx page at the repo root: a single shareable, self-serve guide for enterprise customers running a Mintlify proof of concept.

The doc walks through eight ordered steps (repo connect → team invites → sample content → publish workflow → branding → AI evaluation → IT/security → results review), with upfront workflow tables, participant roles, asset checklists, and success criteria tied to a business baseline. It is noindex: true and intended to stay out of docs.json navigation (same hidden-link pattern as other enterprise pages), so Sales can send a direct URL without surfacing it in the public docs IA.

Content emphasizes mechanics that often block POCs: auth needs a custom domain or *.mintlify.app, dashboard vs reader access, Git-backed publishing with existing review controls, traffic-based sample pages, and assistant scoring by correct citations (not just plausible answers).

Reviewed by Cursor Bugbot for commit 37940fa. Bugbot is set up for automated code reviews on this repo. Configure here.

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

@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>
Editorial pass by Marco. Cuts roughly a third of the page: replaces
the conversational framing with a workflow table up front, converts
the intro card grids to prose and tables, and trims each step to the
action and its outcome.

All substance retained, including the authentication domain
requirement and the split between dashboard access and documentation
access.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Comment thread poc-onboarding.mdx Outdated

### Identify participants

| Participant | Responsibility | Time needed |

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Suggested change
| Participant | Responsibility | Time needed |
| Role | Responsibility | Time needed |

Comment thread poc-onboarding.mdx Outdated

You can also test [preview deployments](/deploy/preview-deployments) for pull requests or [add the agent to Slack](/agent/slack#connect-your-slack-workspace) to propose documentation changes from Slack.

## Step 5: Apply your branding

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Suggested change
## Step 5: Apply your branding
## Step 5: Apply branding

just to match the table at the beginning listing all the steps

Comment thread poc-onboarding.mdx Outdated
- Enable [CI checks](/deploy/ci) for links and accessibility.
- Share [Enterprise contracting](/enterprise-contracting) with security and procurement teams.

## Step 8: Review the results

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Suggested change
## Step 8: Review the results
## Step 8: Review results

matching the intro table

Comment thread poc-onboarding.mdx Outdated
| 4. Publish a change | Verify your writing and review workflow. |
| 5. Apply branding | Match the site to your product. |
| 6. Test AI features | Evaluate assistant answers and one AI workflow. |
| 7. Review security | Confirm authentication and compliance requirements. |

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Suggested change

making it match the later header

Make the step names in the intro workflow table and the section
headings match exactly, and rename the participants table column to
Role.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@DeweyMarco
DeweyMarco merged commit 51bd149 into main Aug 25, 2026
5 checks passed
@DeweyMarco
DeweyMarco deleted the poc-onboarding-guide branch August 25, 2026 16:32
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