Streamline and align the "Getting Started" docs to fit in the new structure
priscilawebdev opened this issue · comments
Problem Statement
- The "Getting Started" documentation for sentry-capacitor platform may not conform to the newly defined format, which includes the steps "Install", "Configure", "Verify", and the optional "Next Steps".
- The "Verify" step is not always available and it is a very important step that helps the user to verify that the installation and configuration were done correctly.
- New users onboarding with Sentry may find the existing documentation extensive and unclear. The "Getting Started" guide should cover the basics, while more advanced configurations shall live on the sentry-docs website.
- Some copies and code snippets in the documentation may be outdated.
Solution Brainstorm
The task goals are as follows:
- Thoroughly review sentry-capacitor platform documentation, and reorganize its content into structured headings: 'Install,' 'Configure,' 'Verify,' and the optional 'Next Steps.'
- The onboarding documentation should strictly focus on the basics to help users get started. Advanced configurations should be available in the complete documentation on the sentry-docs website.
- Essential information for new users should be included under the new 'Notes' section in the onboarding documentation.
- Update code snippets and copies as necessary.
- If a "Verify" step is missing, include it in the documentation.
Please refer to the "Frontendend Handbook" guide in our "Sentry" main repository for assistance in adding and updating the getting started docs: Frontendend Handbook.
Project: getsentry/team-sdks#23
@priscilawebdev I have some questions:
About verify, currently, Capacitor gives multiple ways of testing (as crashing on the Javascript layer but also on the Native case), on the new documentation we only want to have one sample? (ie Javascript capturing an exception)
Could the Next Steps be used to add some additional configuration if the user is using an old SDK?
About verify, currently, Capacitor gives multiple ways of testing (as crashing on the Javascript layer but also on the Native case), on the new documentation we only want to have one sample? (ie Javascript capturing an exception)
yes a simple example would be nice and 1x is enough.
Could the Next Steps be used to add some additional configuration if the user is using an old SDK?
The "next steps" is to promote configurations that might be useful for the users. Keep it simple with just a label, a brief description, and a link to the documentation. If your idea follows this format, feel free to include it 😉
This issue 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 label it Status: Backlog or Status: In Progress, I will leave it alone ... forever!
"A weed is but an unloved flower." ― Ella Wheeler Wilcox 🥀