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

feat(Android): Add docs for Sentry Kotlin Compiler Plugin #7026

Merged
merged 7 commits into from
Jun 5, 2023

Conversation

markushi
Copy link
Member

Pre-merge checklist

If you work at Sentry, you're able to merge your own PR without review, but please don't unless there's a good reason.

  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs
  • PR was reviewed and approved by a member of the Sentry docs team

Description of changes

Describe your changes here. If your PR relates to or resolves an issue, add a link to that too.

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

@markushi markushi requested a review from a team as a code owner May 26, 2023 05:12
@vercel
Copy link

vercel bot commented May 26, 2023

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 Jun 5, 2023 5:35am

Copy link
Member

@romtsn romtsn left a comment

Choose a reason for hiding this comment

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

This looks good, but what do you think about:

  • Having a separate top-level section for the Kotlin Compiler Plugin, explaining its features and how it works (similar to Gradle).
    • Then we could just link to that page from these two
  • I think we should also update https://docs.sentry.io/platforms/android/configuration/integrations/jetpack-compose/ this page with the compiler plugin stuff. Perhaps, we could also mention the view hierarchy there?
    • Dunno but maybe it's time to split this page up into subpages as well

@shanamatthews
Copy link
Contributor

This looks good, but what do you think about:

  • Having a separate top-level section for the Kotlin Compiler Plugin, explaining its features and how it works (similar to Gradle)

    • Then we could just link to that page from these two

I strongly agree with this suggestion. I don't think the current edits give users enough info about the plugin.

No super strong feelings about splitting up this page, but I'm fine with it.

Copy link
Member

@romtsn romtsn left a comment

Choose a reason for hiding this comment

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

Looks good besides 2 minor things 🚀

@markushi markushi merged commit 780b428 into master Jun 5, 2023
@markushi markushi deleted the feat/android-kotlin-compiler-plugin branch June 5, 2023 11:11
@github-actions github-actions bot locked and limited conversation to collaborators Jun 21, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants