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.

Sign up for GitHub

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

Jump to bottom

docs: Add metro config wrapper and reanimated logger docs #6467

Merged
merged 14 commits into from
Sep 11, 2024
Merged

docs: Add metro config wrapper and reanimated logger docs #6467

merged 14 commits into from
Sep 11, 2024

Conversation

MatiPl01
Copy link
Member

@MatiPl01 MatiPl01 commented Aug 30, 2024 •
edited
Loading

Summary

This PR adds pages in docs for the new metro config wrapper and custom logger configuration.

It also changes logger configuration to use the strict mode by default and adds a reference to docs for those would would like to disable strict mode warnings.

I spotted an issue with configureReanimatedLogger on the web, as there is no executeOnUIRuntimeSync in JSReanimated, so I added the necessary check in there as well.

Examples

Metro config docs

Screenshot 2024-08-30 at 17 04 58

Logger config docs

Screenshot 2024-08-30 at 17 04 40

Adjusted message for strict mode warnings

Test plan

Open docs locally and navigate to the new Debugging section.

@MatiPl01 MatiPl01 self-assigned this Aug 30, 2024
@MatiPl01 MatiPl01 marked this pull request as ready for review August 30, 2024 15:18
@MatiPl01 MatiPl01 requested a review from tjzel August 30, 2024 15:18
@tjzel tjzel requested a review from kacperkapusciak August 31, 2024 11:18
@MatiPl01 MatiPl01 force-pushed the @matipl01/debugging-docs branch 2 times, most recently from 0ab9596 to dc73971 Compare September 3, 2024 10:18
@MatiPl01 MatiPl01 requested a review from tjzel September 3, 2024 10:19
kacperkapusciak
kacperkapusciak reviewed Sep 3, 2024
View reviewed changes
packages/react-native-reanimated/src/logger/logger.ts Show resolved Hide resolved
packages/docs-reanimated/docs/fundamentals/getting-started.mdx Show resolved Hide resolved
packages/docs-reanimated/docs/fundamentals/getting-started.mdx Show resolved Hide resolved
packages/docs-reanimated/docs/fundamentals/getting-started.mdx Outdated Show resolved Hide resolved
packages/docs-reanimated/docs/debugging/logger-configuration.mdx Outdated Show resolved Hide resolved
packages/docs-reanimated/docs/debugging/logger-configuration.mdx Outdated Show resolved Hide resolved
packages/docs-reanimated/docs/debugging/logger-configuration.mdx Outdated Show resolved Hide resolved
packages/docs-reanimated/docs/debugging/accurate-call-stacks.mdx Outdated Show resolved Hide resolved
tjzel
tjzel requested changes Sep 3, 2024
View reviewed changes
Copy link
Collaborator

@tjzel tjzel left a comment

Choose a reason for hiding this comment

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

Awesome work, much better than the original version! Still some little bits to improve though.

packages/docs-reanimated/docs/debugging/accurate-call-stacks.mdx Outdated Show resolved Hide resolved
packages/docs-reanimated/docs/debugging/accurate-call-stacks.mdx Outdated Show resolved Hide resolved
packages/docs-reanimated/docs/debugging/accurate-call-stacks.mdx Outdated Show resolved Hide resolved
packages/docs-reanimated/docs/debugging/accurate-call-stacks.mdx Outdated Show resolved Hide resolved
packages/docs-reanimated/docs/debugging/accurate-call-stacks.mdx Outdated Show resolved Hide resolved
packages/docs-reanimated/docs/debugging/logger-configuration.mdx Outdated Show resolved Hide resolved
packages/docs-reanimated/docs/debugging/logger-configuration.mdx Outdated Show resolved Hide resolved
packages/docs-reanimated/docs/debugging/logger-configuration.mdx Outdated Show resolved Hide resolved
packages/docs-reanimated/docs/debugging/logger-configuration.mdx Outdated Show resolved Hide resolved
packages/docs-reanimated/docs/fundamentals/getting-started.mdx Outdated Show resolved Hide resolved
@MatiPl01 MatiPl01 mentioned this pull request Sep 3, 2024
Merged
@MatiPl01 MatiPl01 force-pushed the @matipl01/debugging-docs branch from 7990946 to 893122f Compare September 3, 2024 14:03
@MatiPl01 MatiPl01 changed the base branch from main to @matipl01/logger-config-improvements September 3, 2024 14:04
@MatiPl01 MatiPl01 requested a review from tjzel September 3, 2024 14:04
tjzel
tjzel approved these changes Sep 9, 2024
View reviewed changes
Copy link
Collaborator

@tjzel tjzel left a comment

Choose a reason for hiding this comment

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

Good for me now, let's wait for @kacperkapusciak's review.

packages/docs-reanimated/docs/debugging/accurate-call-stacks.mdx Show resolved Hide resolved
Base automatically changed from @matipl01/logger-config-improvements to main September 9, 2024 11:02
MatiPl01 and others added 9 commits September 9, 2024 13:54
@MatiPl01
Add metro config page to docs
246661d
@MatiPl01
Add logger configuration page to docs
1963f92
@MatiPl01
Small adjusstments, fix for web
5f9aea3
@MatiPl01
Add some changes based on review suggestions
af45461
@MatiPl01
Add some more adjustments
0738f4b
@MatiPl01 @kacperkapusciak
Update packages/docs-reanimated/docs/fundamentals/getting-started.mdx
a8fcbd6 
Co-authored-by: Kacper Kapuściak <39658211+kacperkapusciak@users.noreply.github.com>
@MatiPl01 @kacperkapusciak
Update packages/docs-reanimated/docs/debugging/logger-configuration.mdx
4601f2d 
Co-authored-by: Kacper Kapuściak <39658211+kacperkapusciak@users.noreply.github.com>
@MatiPl01 @tjzel
Update packages/docs-reanimated/docs/debugging/accurate-call-stacks.mdx
3f8e6b2 
Co-authored-by: Tomasz Żelawski <40713406+tjzel@users.noreply.github.com>
@MatiPl01 @tjzel
Update packages/docs-reanimated/docs/debugging/accurate-call-stacks.mdx
a17bd56 
Co-authored-by: Tomasz Żelawski <40713406+tjzel@users.noreply.github.com>
MatiPl01 and others added 4 commits September 9, 2024 13:54
@MatiPl01 @tjzel
Update packages/docs-reanimated/docs/debugging/accurate-call-stacks.mdx
f1daba5 
Co-authored-by: Tomasz Żelawski <40713406+tjzel@users.noreply.github.com>
@MatiPl01 @tjzel
Update packages/docs-reanimated/docs/debugging/logger-configuration.mdx
b0ce4c2 
Co-authored-by: Tomasz Żelawski <40713406+tjzel@users.noreply.github.com>
@MatiPl01
Apply some more review suggestions
dece2d1
@MatiPl01
Some more adjustments
b99f8c9
@MatiPl01 MatiPl01 force-pushed the @matipl01/debugging-docs branch from 893122f to b99f8c9 Compare September 9, 2024 11:54
@tjzel tjzel mentioned this pull request Sep 9, 2024
Merged
github-merge-queue bot pushed a commit that referenced this pull request Sep 9, 2024
@tjzel
chore: Bump prettier in docs (#6497)
1754695 
## Summary

After bumping Prettier in the monorepo docs should have it bumped too
since they inherit `prettier.config.js`.

Fixes CI failing in:
- #6467 
- #6468
@MatiPl01 MatiPl01 added this pull request to the merge queue Sep 11, 2024
Merged via the queue into main with commit 6ed8aca Sep 11, 2024
9 checks passed
@MatiPl01 MatiPl01 deleted the @matipl01/debugging-docs branch September 11, 2024 14:20
This was referenced Nov 8, 2024
Open
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tjzel tjzel tjzel approved these changes

@kacperkapusciak kacperkapusciak kacperkapusciak approved these changes

Assignees

@MatiPl01 MatiPl01

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@MatiPl01 @kacperkapusciak @tjzel