Skip to content

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

@priscilawebdev

Description

@priscilawebdev

Problem Statement

  • The "Getting Started" documentation for sentry-unreal 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-unreal 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

Metadata

Metadata

Assignees

No one assigned

    Labels

    FeatureNew feature or request

    Projects

    Status

    Todo

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions