feat(kmp): update getting started and add manual setup page
Current code snippet example doesn't compile in dart
DESCRIBE YOUR PR
Tell us what you're changing and why. If your PR resolves an issue, please link it so it closes automatically.
IS YOUR CHANGE URGENT?
Help us prioritize incoming PRs by letting us know when the change needs to go live.
- [ ] Urgent deadline (GA date, etc.):
- [ ] Other deadline:
- [x] None: Not urgent, can wait up to 1 week+
SLA
- Teamwork makes the dream work, so please add a reviewer to your PRs.
- Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it. Thanks in advance for your help!
PRE-MERGE CHECKLIST
Make sure you've checked the following before merging your changes:
- [ ] Checked Vercel preview for correctness, including links
- [ ] PR was reviewed and approved by any necessary SMEs (subject matter experts)
- [ ] PR was reviewed and approved by a member of the Sentry docs team
LEGAL BOILERPLATE
Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.
EXTRA RESOURCES
- Sentry Docs contributor guide Current code snippet example doesn't compile in dartCurrent code snippet example doesn't compile in dart
The latest updates on your projects. Learn more about Vercel for Git ↗︎
| Name | Status | Preview | Comments | Updated (UTC) |
|---|---|---|---|---|
| sentry-docs | ✅ Ready (Inspect) | Visit Preview | 💬 Add feedback | Nov 26, 2024 4:10pm |
2 Skipped Deployments
| Name | Status | Preview | Comments | Updated (UTC) |
|---|---|---|---|---|
| changelog | ⬜️ Ignored (Inspect) | Visit Preview | Nov 26, 2024 4:10pm | |
| develop-docs | ⬜️ Ignored (Inspect) | Visit Preview | Nov 26, 2024 4:10pm |
Bundle Report
Changes will increase total bundle size by 15.21MB (107.55%) :arrow_up::warning:, exceeding the configured threshold of 5%.
| Bundle name | Size | Change |
|---|---|---|
| sentry-docs-server* | 8.37MB | 8.37MB (100%) :arrow_up::warning: |
| sentry-docs-edge-server* | 254.34kB | 254.34kB (100%) :arrow_up::warning: |
| sentry-docs-client* | 6.39MB | 6.39MB (100%) :arrow_up::warning: |
| sentry-docs-server-cjs | 7.58MB | 201.91kB (2.74%) :arrow_up: |
| sentry-docs-edge-server-array-push | 333.11kB | 3 bytes (-0.0%) :arrow_down: |
| sentry-docs-client-array-push | 6.44MB | 6 bytes (-0.0%) :arrow_down: |
ℹ️ *Bundle size includes cached data from a previous commit
@buenaflor the changes are good IMO, just a thought on taking this further - we recently streamlined the getting started pages for the other (main) mobile platforms so that it contains the most relevant steps for new setups and focuses on Install, Configure, Verify. everything else is links to subpages from within the text (as needed) and a Next Steps section at the end. do you think it makes sense to expand this PR to this format?
yep makes sense, I'll adapt this
I updated the getting started page to focus on install, configure and verify
I've spread out the rest into separate files @kahest
This pull request has gone three weeks without activity. In another week, I will close it.
But! If you comment or otherwise update it, I will reset the clock, and if you add the label WIP, I will leave it alone unless WIP is removed ... forever!
"A weed is but an unloved flower." ― Ella Wheeler Wilcox 🥀
how important are configuration options for new users versus the folders we're putting above them
in most case they're not, this setup is supposed to install everything automatically and should rarely need a manual change of the configuration (at least that's what I hope)