Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Streamline and align the "Getting Started" docs to fit in the new structure #111

Open
Tracked by #23
priscilawebdev opened this issue Aug 4, 2023 · 1 comment
Open
Tracked by #23

Comments

@priscilawebdev
Copy link
Member

priscilawebdev commented Aug 4, 2023

Problem Statement

  • The "Getting Started" documentation for sentry-kotlin-multiplatform platforms 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 all sentry-kotlin-multiplatform platform documentation, including less commonly used sections, and reorganize their 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

@kahest
Copy link
Member

kahest commented Sep 26, 2023

This means creating KMP Getting Started/Onboarding docs from scratch

# for free to join this conversation on GitHub. Already have an account? # to comment
Projects
Status: Backlog
Development

No branches or pull requests

2 participants