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

Update the "Best Practices & Limitations" page #301

Merged
merged 1 commit into from
Sep 4, 2024

Conversation

MGaetan89
Copy link
Member

@MGaetan89 MGaetan89 commented Sep 3, 2024

This PR updates the Best Practices & Limitations page.

It adds links to external documentation where possible.


It also simplifies the Customizing the Test Runner page, since most of the documentation is on Hilt side. I feel that this page does no longer bring any useful information. Does it make sense to keep it? It used to have more, but it was mainly for RoboGuice.
If we remove it, the Build System Integration page could go in the "User Guide" section instead.

This PR updates the [Best Practices & Limitations](https://robolectric.org/best-practices/) page.

It adds links to external documentation where possible.

It also simplifies the `Customizing the Test Runner` page, since most of the documentation is on Hilt side.
@MGaetan89 MGaetan89 merged commit 70f6f72 into robolectric:master Sep 4, 2024
1 check passed
@MGaetan89 MGaetan89 deleted the update_best_practices branch September 4, 2024 06:27
@MGaetan89
Copy link
Member Author

Thanks for the review @utzcoz. The Customizing the Test Runner page now looks like this:
Screenshot 2024-09-04 at 08 31 30

Do you think it makes sense to keep it, considering the small amount of information it provides?
We could drop it, and move Build System Integration into the User Guide section instead.

@utzcoz
Copy link
Member

utzcoz commented Sep 4, 2024

I still want to keep this page. Beside of current di configuration hint, we also can support more content related to test runner customization.

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.

2 participants