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 contributing docs page #6061

Merged
merged 32 commits into from
Jun 17, 2024
Merged
Show file tree
Hide file tree
Changes from 25 commits
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
6861652
chore: finish structure and contributing to docs section
maciekstosio May 13, 2024
f4a74a6
chore: finish structure and contributing to docs sections
maciekstosio May 13, 2024
da5a52a
chore: start progress on Contribute to code section
maciekstosio May 13, 2024
9ae7412
First draft of contributing guide
maciekstosio May 29, 2024
3babc27
Add discord contact information
maciekstosio Jun 3, 2024
203542d
Add link to contributing guide on outdated pages
maciekstosio Jun 3, 2024
7efd9a6
Change placment of discord contatct info
maciekstosio Jun 3, 2024
d02d821
Merge current main
kacperkapusciak Jun 7, 2024
8b9eb5e
Reformat contributing.mdx, fix typos
kacperkapusciak Jun 7, 2024
1dd801a
Rename docs compatibility info component, make it private
kacperkapusciak Jun 7, 2024
f4512bb
Draft documentation writing style guide
kacperkapusciak Jun 7, 2024
075dd2d
Stash work
kacperkapusciak Jun 7, 2024
f7fb0d2
Merge remote-tracking branch 'origin/main' into @maciekstosio/Contrib…
kacperkapusciak Jun 12, 2024
ec26fa5
fix merge conflict issues
kacperkapusciak Jun 12, 2024
53c9edb
Finish docs style guide
kacperkapusciak Jun 12, 2024
19fbd84
Update the guides for monorepo
kacperkapusciak Jun 12, 2024
dd2ddaa
Improve contributing
kacperkapusciak Jun 12, 2024
079fcd9
Improve contributing even more
kacperkapusciak Jun 13, 2024
3a19d0b
Merge current main
kacperkapusciak Jun 13, 2024
dc38a83
Moar changes
kacperkapusciak Jun 13, 2024
df09881
Unordered list should be unordered
kacperkapusciak Jun 13, 2024
cf7f155
Resolve merge conflict changes
kacperkapusciak Jun 13, 2024
edb2452
Moar merge conflict changes
kacperkapusciak Jun 13, 2024
f4f16ca
Merge current main again pls stop
kacperkapusciak Jun 13, 2024
6e8f8a9
Update docs structure
kacperkapusciak Jun 13, 2024
456d7a1
Apply suggestions from code review
kacperkapusciak Jun 13, 2024
7a16a71
chore: path changes after change to monorepo
maciekstosio Jun 13, 2024
5b0f1db
fix: fix typo
maciekstosio Jun 13, 2024
48019a8
chore: fix positive to negative sentence
maciekstosio Jun 14, 2024
0b194ed
fix: remove unnecessary import from example
maciekstosio Jun 14, 2024
6c61a81
chore: yarn format
maciekstosio Jun 14, 2024
c4287da
chore: remove project structure overview
maciekstosio Jun 17, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
:::info
This page was ported from an old version of the documentation.

As we're rewriting the documentation some of the pages might be a little outdated.

If you'd like to help with transition you can find guidelines in [contributing guide](/docs/guides/contributing#helping-with-documentation).

:::
6 changes: 2 additions & 4 deletions packages/docs-reanimated/docs/advanced/dispatchCommand.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,9 @@ sidebar_position: 7

# dispatchCommand

:::info
This page was ported from an old version of the documentation.
import DocsCompatibilityInfo from '../_shared/_docs_compatibility_info.mdx';

As we're rewriting the documentation some of the pages might be a little outdated.
:::
<DocsCompatibilityInfo />

Allows to dispatch command on a native component synchronously from the UI thread.

Expand Down
6 changes: 2 additions & 4 deletions packages/docs-reanimated/docs/advanced/useEvent.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,9 @@ sidebar_position: 4

# useEvent

:::info
This page was ported from an old version of the documentation.
import DocsCompatibilityInfo from '../_shared/_docs_compatibility_info.mdx';

As we're rewriting the documentation some of the pages might be a little outdated.
:::
<DocsCompatibilityInfo />

This is low-level hook returning event handler that will be invoked with native events, which should be used in order to create custom event handler hook like `useAnimatedGestureHandler` or `useAnimatedScrollHandler`.

Expand Down
6 changes: 2 additions & 4 deletions packages/docs-reanimated/docs/advanced/useHandler.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,9 @@ sidebar_position: 5

# useHandler

:::info
This page was ported from an old version of the documentation.
import DocsCompatibilityInfo from '../_shared/_docs_compatibility_info.mdx';

As we're rewriting the documentation some of the pages might be a little outdated.
:::
<DocsCompatibilityInfo />

This is low-level hook returning context object and value indicating whether worklet should be rebuilt, which should be used in order to create custom event handler hook like `useAnimatedGestureHandler` or `useAnimatedScrollHandler`.

Expand Down
318 changes: 318 additions & 0 deletions packages/docs-reanimated/docs/guides/contributing.mdx

Large diffs are not rendered by default.

9 changes: 3 additions & 6 deletions packages/docs-reanimated/docs/guides/debugging-worklets.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,6 @@ title: 'Debugging worklets'
sidebar_label: 'Debugging worklets'
---

:::info
This page was ported from an old version of the documentation.

As we're rewriting the documentation some of the pages might be a little outdated.
:::

import {
SummaryTable,
ChromeDebuggerTable,
Expand All @@ -18,6 +12,9 @@ import {
SafariDevToolsTable,
ReactDeveloperToolsTable,
} from './debugging_tables/tables';
import DocsCompatibilityInfo from '../_shared/_docs_compatibility_info.mdx';

<DocsCompatibilityInfo />

Due to Reanimated's unique architecture and usage of a second JS runtime, debugging
can be problematic, and some common solutions might not work as expected.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,9 @@ title: 'Testing with Jest'
sidebar_label: 'Testing with Jest'
---

:::info
This page was ported from an old version of the documentation.
import DocsCompatibilityInfo from '../_shared/_docs_compatibility_info.mdx';

As we're rewriting the documentation some of the pages might be a little outdated.
:::
<DocsCompatibilityInfo />

Reanimated test mocks use web implementation of Reanimated2. Before you begin using Reanimated mocks you need some setup actions.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,9 @@ title: Web Support
sidebar_label: Web Support
---

:::info
This page was ported from an old version of the documentation.
import DocsCompatibilityInfo from '../_shared/_docs_compatibility_info.mdx';

As we're rewriting the documentation some of the pages might be a little outdated.
:::
<DocsCompatibilityInfo />

It's possible to launch Reanimated in a web browser. For that case all of the functionalities are implemented purely in JavaScript, hence the efficiency of the animations might be lower.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,9 @@ sidebar_position: 4

# Custom animations

:::info
This page was ported from an old version of the documentation.
import DocsCompatibilityInfo from '../_shared/_docs_compatibility_info.mdx';

As we're rewriting the documentation some of the pages might be a little outdated.
:::
<DocsCompatibilityInfo />

If our set of predefined animations is not enough for you then this tab is what you are looking for.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,9 @@ sidebar_position: 2

# Keyframe animations

:::info
This page was ported from an old version of the documentation.
import DocsCompatibilityInfo from '../_shared/_docs_compatibility_info.mdx';

As we're rewriting the documentation some of the pages might be a little outdated.
:::
<DocsCompatibilityInfo />

The document explains how you can define complex animation using simple and popular animation definitions schema - Keyframes.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,9 @@ sidebar_position: 3

# Layout transitions

:::info
This page was ported from an old version of the documentation.
import DocsCompatibilityInfo from '../_shared/_docs_compatibility_info.mdx';

As we're rewriting the documentation some of the pages might be a little outdated.
:::
<DocsCompatibilityInfo />

The document explains how can you animate all layout changes for a specific view just by adding a single property to the view.
To be precise how to animate positions and dimensions of components. What's important it will all happen entirely on UI thread without any communication through the bridge. There are plenty of ways in which you can animated layout changes however in contrast to entering and exiting animations they are not so regular. We've prepared a few predefined layout transitions, however if you want to create more custom and complex transition you can create your own.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,9 @@ sidebar_position: 3

# useAnimatedScrollHandler

:::info
This page was ported from an old version of the documentation.
import DocsCompatibilityInfo from '../_shared/_docs_compatibility_info.mdx';

As we're rewriting the documentation some of the pages might be a little outdated.
:::
<DocsCompatibilityInfo />

This is a convenience hook that returns an event handler reference which can be used with React Native's scrollable components.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,9 @@ title: Shared Element Transitions
sidebar_label: Overview
---

:::info
This page was ported from an old version of the documentation.
import DocsCompatibilityInfo from '../_shared/_docs_compatibility_info.mdx';

As we're rewriting the documentation some of the pages might be a little outdated.
:::
<DocsCompatibilityInfo />

:::caution

Expand Down
6 changes: 2 additions & 4 deletions packages/docs-reanimated/docs/utilities/getRelativeCoords.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,9 @@ sidebar_position: 4

# getRelativeCoords

:::info
This page was ported from an old version of the documentation.
import DocsCompatibilityInfo from '../_shared/_docs_compatibility_info.mdx';

As we're rewriting the documentation some of the pages might be a little outdated.
:::
<DocsCompatibilityInfo />

Determines the location on the screen, relative to the given view. It might be useful when there are only absolute coordinates available and you need coordinates relative to the parent.

Expand Down
6 changes: 2 additions & 4 deletions packages/docs-reanimated/docs/utilities/interpolateColor.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,9 @@ sidebar_position: 3

# interpolateColor

:::info
This page was ported from an old version of the documentation.
import DocsCompatibilityInfo from '../_shared/_docs_compatibility_info.mdx';

As we're rewriting the documentation some of the pages might be a little outdated.
:::
<DocsCompatibilityInfo />

Maps input range to output colors using linear interpolation. It works just like `interpolate` function but the output is color string in `rgba(r, g, b, a)` notation.

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.