Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

docs: Add mobile/native symbols docs #217

Merged
merged 2 commits into from
Dec 19, 2024

Conversation

sumitramanga
Copy link
Collaborator

@sumitramanga sumitramanga commented Dec 17, 2024

docs: Add mobile/native symbols docs

Description 📝

  • Purpose: We are about to release the Flutter mobile/native symbols work, therefore, we need some form of docs on how to set up
  • Approach: This PR adds docs on getting started on Flutter mobile symbols

Type of change

Delete options that are not relevant.

  • This change requires a documentation update

Updates
👉 Add section on Flutter mobile symbols instructions
👉 Remove the "In the future, Raygun aims to support this functionality directly in the website." since we are going to support

Screenshots 📷

N/A

Test plan 🧪

Provide guidance for how to QA your proposed changes. This is not only for a test but also useful for a reviewer.

Docs appear correctly in the README

Author to check 👓

  • Project and all contained modules builds successfully
  • Self-/dev-tested
  • Unit/UI/Automation/Integration tests provided where applicable
  • Code is written to standards
  • Appropriate documentation written (code comments, internal docs)

Reviewer to check ✔️

  • Project and all contained modules builds successfully
  • Change has been dev-/reviewer-tested, where possible
  • Unit/UI/Automation/Integration tests provided where applicable
  • Code is written to standards
  • Appropriate documentation written (code comments, internal docs)

@sumitramanga sumitramanga changed the title [R1-67]: Add mobile/native symbols docs docs: Add mobile/native symbols docs Dec 17, 2024
Rearranged the content flow a bit, so that @sumitramanga's new section is now a sub-chapter of the general obfuscation section.
@TheRealAgentK
Copy link
Contributor

Shuffled @sumitramanga's new content into a different place where it fits better.

@miquelbeltran
Copy link
Collaborator

The CI check fail is not related. I will fix in another PR.


The version is required to match with the `version` located in the crash report. In order to ensure we process your intended crash reports.

To set the `version`, you can add the version during the initialization (`Raygun.init`) or calling `.setVersion()` where it is avaliable. More information can be find in the [Setup and usage section](https://github.com/MindscapeHQ/raygun4flutter?tab=readme-ov-file#setup-and-usage)
Copy link
Collaborator

Choose a reason for hiding this comment

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

Version is also read automatically using the package_info_plus, so usually users no need to provide it.

@sumitramanga sumitramanga merged commit b2cb8a5 into develop Dec 19, 2024
13 of 14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants