Skip to content

docs: fix Getting Started docs — 7 pages (7 issues)#301

Open
bobbyg603 wants to merge 1 commit into
masterfrom
docs-audit/getting-started
Open

docs: fix Getting Started docs — 7 pages (7 issues)#301
bobbyg603 wants to merge 1 commit into
masterfrom
docs-audit/getting-started

Conversation

@bobbyg603

Copy link
Copy Markdown
Member

Applies verified fixes from the July 2026 docs audit to 7 pages in this section.

Every change is grounded in the current state of the product code or SDK repos (the audit findings carry file:line evidence). Screenshot/media updates are not in this PR — those are deferred to a separate follow-up.

Pages fixed

Closes

Fixes #247
Fixes #248
Fixes #280
Fixes #281
Fixes #282
Fixes #283
Fixes #284

🤖 Generated with Claude Code

Applies verified audit fixes to 7 pages in this section.
Evidence-backed against current product code and SDK repos.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Updates 7 “Getting Started” documentation pages to reflect current BugSplat product/UI behavior and current sample/SDK references, based on the July 2026 docs audit findings.

Changes:

  • Corrected default size limits in Troubleshooting (crash upload + symbol limits).
  • Updated onboarding/sign-up and sample-crash instructions to match current UI flows and required fields.
  • Fixed outdated/deprecated links and code samples (support mailto, renamed sample repos, Windows C++ ASan API).

Reviewed changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
introduction/getting-started/adding-uses-to-your-account.md Updates per-database invite guidance and button label to match current UI flow.
introduction/getting-started/create-a-new-database-in-bugsplat.md Replaces outdated “click logo” onboarding navigation with a direct onboarding link.
introduction/getting-started/posting-a-test-crash/README.md Fixes support mailto address and updates sample repo links (CMake/React).
introduction/getting-started/posting-a-test-crash/myconsolecrasher-c-plus-plus/address-sanitizer-reports.md Updates ASan example code to current Windows C++ SDK API (BugSplat / CreateAsanReport).
introduction/getting-started/quickly-submitting-your-first-crash-in-under-5-minutes.md Updates steps and UI wording for posting a sample crash and onboarding navigation.
introduction/getting-started/signing-up-for-an-account-with-bugsplat.md Documents the actual required sign-up fields and password requirements.
introduction/getting-started/troubleshooting.md Updates stated crash/symbol size limits to current defaults.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment on lines 9 to +11
## Adding Team Members to a Specific Databases ⚽

Only need to add a team member to a specific subset of databases? Navigate to the [Manage Users](https://app.bugsplat.com/v2/company/users) page in Settings and select the desired database from the dropdown selector.
Only need to add a team member to a specific subset of databases? Select the desired database, then navigate to its [Users](https://app.bugsplat.com/v2/database/users) page in Settings.
### Step 4: Submitting a Sample Crash

Once you've selected your platform or SDK, you'll be taken to our documentation page. To quickly submit a sample crash without going through the full integration process, scroll down to the bottom right of the page and click the button labeled "**In a hurry? Post a sample crash instead**." This allows you to skip the full integration process for now and submit a sample crash directly.
Once you've selected your platform or SDK, you'll be taken to our documentation page. To quickly submit a sample crash without going through the full integration process, click the "**Post sample crash**" button in the sidebar status card. This allows you to skip the full integration process for now and submit a sample crash directly.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment