Migrate Zendesk support KB content into docs (Phase 1 + Phase 2) - #116
Closed
Roman-SE260 wants to merge 13 commits into
Closed
Roman-SE260 wants to merge 13 commits into
Roman-SE260 wants to merge 13 commits into
Conversation
Sourced from a full audit of the StreamElements support KB (Zendesk) against docs.streamelements.com, ahead of retiring the support KB (Zendesk's API no longer supports article create/update). SE.Live: - New pages: uninstall.mdx, guides/youtube-setup.mdx - getting-started.mdx: requirements block, run-as-admin step, StreamElements menu overview, Cloud Backup section - troubleshooting.mdx: X/Twitter login, Stream Deck path sensitivity, fuller audio setup, GPU encoding note, crash isolation + --setrace + memory dump steps, uninstall link - guides/overlays-and-alerts.mdx: testing tips, scene naming, Themes Gallery, stronger URL security note, link to new AlertBox variations page - guides/multistreaming.mdx: recommended specs, X/Twitter note, fuller TikTok behavior, FAQ section - guides/twitch-dual-format.mdx: FAQ (Twitch beta approval, OBS 32 stability), Known Issues section - guides/scenes-and-sources.mdx: Advanced Encoding Options (beta) note, Stream Deck auto-sync note - guides/backtrack.mdx: already covered the identified gaps, no change needed Chatbot: - New pages: platforms.mdx (Twitch/YouTube/Kick setup + FAQ, tabbed), user-management.mdx, guides/bot-detection.mdx, guides/run-ads.mdx - getting-started.mdx, troubleshooting.md, index.mdx: cross-links to the above - VALORANT rank-command guide intentionally NOT migrated: source API (glitch.me) is confirmed dead (Glitch shut down app hosting July 2025), and there's no native rank variable to replace it with. Needs a product/eng decision before this can be drafted. Overlays: - New pages: broadcast-software.mdx, alertbox-variations.mdx, kappagen.mdx, widget-data.mdx, chat-widget.mdx, troubleshooting.md - getting-started.mdx, index.mdx, session-data.md: cross-links + sidebar restructure (split streamer Guides from developer Custom Widgets) - Elements Editor content intentionally excluded: product is being redesigned imminently per stakeholder call, not worth documenting a UI about to change. Contradictions between support and docs (macOS support, OBS version for dual format, dual-format beta gating) were left as docs already had them, per instruction that docs is the source of truth. Not independently re-verified against the product -- flagging for a final eng sanity check before merging. No real screenshots included; new pages are written to stand on their own without images. Existing GuideScreenshot images referenced by edited pages are unchanged.
…idator)
- overlays/troubleshooting.md: {#xsplit} custom-id syntax isn't honored in
plain .md, producing id="xsplit-xsplit" instead. Removed it; default
slug of the heading text is #xsplit, matching the link that pointed here.
- selive/guides/youtube-setup.mdx: linked to /chatbot/platforms#youtube, but
Tabs/TabItem tab labels aren't headings and produce no anchor. Reworded
to link the page without a fragment.
Also added node_modules/, package-lock.json, and dist/ to .gitignore --
running npm install/build locally for validation shouldn't leave build
artifacts in this diff.
…Store, troubleshooting)
Ground Control: 1 page, separated from SE.Live per instruction (it's a genuinely separate desktop app, not an SE.Live feature). Media Requests: 2 support articles consolidated into 1 page per instruction.
Consolidated from 11 support articles per instruction (Campaigns scoped to SE.Sponsorships only, no Charity grouping): Overview merges the original Overview + General FAQ + Eligibility FAQ articles into one page with a trimmed FAQ; Payments, Staying Compliant, Subscription-Based Campaigns, Optional Bonus Goals, In-Game Budget Goal, and the OBS overlay setup guide each keep their own page; the two troubleshooting articles (sign-ups not tracked, stream time not tracked) merge into one Troubleshooting page. Dropped a stale cross-reference found in the original Overview article, which linked to the wrong article ID for the Payment FAQ.
…o it Overview: Revenue History page, tax form thresholds/delivery by income type, Payments Portal (Tipalti) setup for sponsorship payouts. Tipping: PayPal setup, Tipping Settings walkthrough, Tip Moderation, tip alerts pointer, viewer-facing FAQ. Charity Streams: folded in here per instruction rather than its own topic — Tiltify and DonorDrive integration guides. Dropped a stale, time-bound 2021 Pride Month / It Gets Better Project promotion that the original Tiltify article was built around; kept only the generic, still-accurate setup steps. SE.Pay: rewritten from scratch based on clarification -- SE.Pay as a whole is currently disabled for new setup. Legacy (Adyen) is on hold and fully discontinued Dec 31 2026; the Stripe-based replacement is in closed beta. Both are covered with an explicit distinction, since both audiences (existing Legacy holders and current beta participants) need accurate info. Intentionally did NOT carry over the old SE.Pay Overview article's specific eligibility criteria (18+, 100 followers, country list) since those read as tied to the old manual-activation Legacy flow and are unconfirmed for the Stripe beta -- flagged to Roman rather than guessing.
Verification is now automated rather than manual/support-ticket based, but the underlying criteria (18+, 100+ followers, supported-country bank account, 3 months consistent streaming) still apply and should stay visible -- otherwise creators without access have no explanation and file tickets.
Consolidated from 16 in-scope support articles (17 total minus Facebook Live, which is dropped entirely per instruction -- StreamElements no longer supports it). Also dropped the Acquisition FAQ (Razer acquisition) per instruction -- no longer news, and out of scope for this migration. Pages: Overview, Create Your Account (account creation + the 4-step initial setup wizard), Dashboard & Activity Feed (merges the separate Multiplatform Activity Feed article, which fully duplicated a section of the Activity Feed Overview article), Your Public Profile, Account Settings (merges 4 separate articles: updating email, finding Account ID/JWT, unlinking a channel, closing an account -- these are all facets of the same 'manage my account' task), Granting Mod Dashboard Access, Importing from Other Platforms, Enable Live Streaming on YouTube, and a consolidated Troubleshooting page (merges General Troubleshooting Guide + Activity Feed Not Updating, which had overlapping Twitch/YouTube event-troubleshooting steps). Content-quality notes from source material, for awareness: - Several source articles contained literal leftover ChatGPT-conversation HTML (data-message-author-role, gizmo-bot-avatar classes, etc.) pasted directly into the CMS. Cleaned up, obviously not carried into docs. - Dropped a stale 'unlinking Mixer isn't possible' note (Mixer shut down in 2020). - Account creation login options standardized to Twitch/YouTube/Kick/TikTok per instruction; dropped inconsistent Trovo/X mentions found across multiple source articles (X explicitly excluded from docs per instruction -- tooling support is minimal enough there that featuring it would read as an afterthought, even though it's technically supported). Getting Started is now first in the sidebar, before Campaigns, per instruction. This closes out every Phase 2 topic: Getting Started, Campaigns, Revenue, Loyalty & Stream Store, Ground Control, Media Requests.
The product picker is a short list of products. Getting Started, Campaigns, Revenue, Loyalty, Media Requests, and Ground Control are dashboard features, and two of them are a single page each. Grouping them under one Dashboard topic keeps the picker at five rows. URLs are unchanged. Also cross-links the Media Requests page and the Song Request module, which cover the same feature from the dashboard and chat sides.
A start-to-finish, YouTube-specific walkthrough covering account setup, the dashboard, overlays, connecting OBS, and the chatbot. Nested under Getting Started in the Dashboard sidebar topic, with screenshots for each dashboard step. Co-Authored-By: Claude Sonnet 5 <[email protected]>
This reverts commit 39063e0.
Deploying with
|
| Status | Name | Latest Commit | Updated (UTC) |
|---|---|---|---|
| ✅ Deployment successful! View logs |
docs | 6c8b98d | Sep 18 2026, 01:23 PM |
Add six YouTube quickstart pages under SE.Live with 24 screenshots. Cover account setup, the dashboard, overlays, OBS with SE.Live, and chatbot setup. Build and internal link validation pass.
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
2 participants
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.
Summary
Migrates StreamElements' support KB (Zendesk) content into docs.streamelements.com, ahead of Zendesk's API being retired for article creation/updates.
Replaces #113 (opened from a fork, before direct write access to this repo existed). Same content, no changes — just re-opened as a same-repo PR now that
docs-migrationlives here directly. Includes #115: the YouTube quickstart appears as one entry under SE.Live → Guides with a “5 parts” badge. Its overview links to all five steps, and each step has previous/next links and a link back to the overview.Open items for reviewers
Test plan
npm run buildpasses (link validator clean)🤖 Generated with Claude Code