TOF-444: Split the troubleshooting FAQ mega-page into per-topic, per-question pages - #177
Open
tylergoerzen-mxp with Copilot wants to merge 5 commits into
Open
TOF-444: Split the troubleshooting FAQ mega-page into per-topic, per-question pages#177tylergoerzen-mxp with Copilot wants to merge 5 commits into
tylergoerzen-mxp with Copilot wants to merge 5 commits into
Conversation
Co-authored-by: tylergoerzen-mxp <259741734+tylergoerzen-mxp@users.noreply.github.com>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Copilot
AI
changed the title
[WIP] Split troubleshooting FAQ into per-topic pages
TOF-444: Split troubleshooting FAQ mega-page into per-topic pages
Aug 18, 2026
Contributor
Confidence Score: 5/5The PR appears safe to merge. No blocking failure remains.
|
| Filename | Overview |
|---|---|
| docs.json | Registers the FAQ hub and all seven topic pages in navigation. |
| troubleshooting/faqs.mdx | Retains the legacy URL as a hub linking all topic and feature-specific FAQ pages. |
| troubleshooting/general.mdx | Adds descriptive metadata and converts questions to search-friendly H2 sections. |
| troubleshooting/sending-data.mdx | Moves sending-data answers into a dedicated page with corrected absolute links. |
| troubleshooting/identity-management.mdx | Moves identity questions into a dedicated page using H2 headings. |
| troubleshooting/building-reports.mdx | Adds a dedicated reports FAQ page with descriptive metadata. |
| troubleshooting/exporting-data.mdx | Adds a dedicated data-export FAQ page with descriptive metadata. |
| troubleshooting/managing-projects.mdx | Adds a dedicated project-administration FAQ page with descriptive metadata. |
| troubleshooting/protecting-user-data.mdx | Adds a dedicated privacy FAQ page with descriptive metadata. |
Reviews (5): Last reviewed commit: "Merge branch 'main' into copilot/tof-444..." | Re-trigger Greptile
The redirect to /troubleshooting/general would have broken all seven section anchors: Mintlify redirects cannot match a #fragment, so /troubleshooting/faqs#exporting-data-from-mixpanel landed on an unrelated page at a dead anchor. Restore the URL as an index page whose H2s are copied verbatim from the original, so every existing deep link resolves. Also give each split page a description and an opening line, instead of starting cold on a bare <AccordionGroup>. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Rec #3 asks for each question to be an H2 whose first paragraph is the direct answer. Accordion titles generate no heading anchors, so an answer engine could cite the page but not the specific question, and readers had no deep link to share. Converted all 70 accordions across the seven topic pages. Verified: question count 70 before and after, titles byte-identical and in the same order, zero answer lines lost, code fences still balanced. Also checked rec #3's merge requirement: the split produced no duplicates of the existing Funnels or Group Analytics FAQ pages (zero overlapping questions), so there is nothing to merge. Linked both from the hub instead so readers can find them. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
tylergoerzen-mxp
marked this pull request as ready for review
August 20, 2026 07:59
tylergoerzen-mxp
approved these changes
Aug 20, 2026
tiffanyqi
approved these changes
Aug 20, 2026
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.
Splits
troubleshooting/faqs.mdx— 70 questions on one URL — into seven per-topic pages, each question its own##heading.Relates to: https://linear.app/mixpanel/issue/TOF-444/aeo-qw7-split-the-troubleshooting-faq-mega-page-into-per-topic-pages
Why this matters for AEO
The old page had good answers. The problem was packaging: answer engines retrieve passages but cite URLs, so one URL cannot win 70 distinct queries no matter how well written it is.
Three measured effects, from the AEO plan:
Concretely: a page titled "Frequently Asked Questions" matches almost nothing. Seven pages titled for their topic, each with 10ish question headings whose first paragraph is the answer, match the way people actually ask.
Why
##headings instead of accordions. Accordion titles generate no heading anchors, so a passage could be retrieved but not deep-linked, and nobody could share a link to one answer. Each question now has its own anchor. Visible Q&A copy is also what still helps — FAQ schema markup was deprecated in 2023 and correlates with slightly fewer citations, so the win here is structural HTML, not markup.Descriptions were added to all seven pages. Mintlify generates
llms.txtfrom that field, and an entry without one renders bare.Changes
Seven new pages under
troubleshooting/:general,sending-data,identity-management,building-reports,exporting-data,managing-projects,protecting-user-data.Each opens with a one-line orienting sentence, then
##per question with the answer directly beneath./troubleshooting/faqsstays live as a hub. An earlier revision redirected it to/troubleshooting/general. That was wrong: Mintlify redirects cannot match a#fragment, so/troubleshooting/faqs#exporting-data-from-mixpanelwould have landed on an unrelated page at a dead anchor. The URL is now an index page whose seven##headings are copied verbatim from the original, so every existing deep link still resolves. It also links the Funnels and Group Analytics FAQs.docs.json— FAQs tab becomes a group listing the hub plus all seven pages.Bug fixes found during the split: two internal links in
sending-datawere missing a leading/.Verification
identity-managementsurvived dedenting intact.