Skip to content

chore: prepare docs for Docusaurus v3 upgrade - 3rd iteration #3843

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

Merged
elicwhite merged 6 commits into from
Sep 3, 2023
Merged

chore: prepare docs for Docusaurus v3 upgrade - 3rd iteration #3843

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
3d9b24c
remove useless $Enum escaping
slorber Sep 2, 2023
175ce23
Fix button colors default value
slorber Sep 2, 2023
71cf384
Fix color keywords
slorber Sep 2, 2023
d4ceccc
Fix admonition important => info
slorber Sep 2, 2023
f217be0
Fix bad usage of anchor syntax
slorber Sep 2, 2023
077882d
Wrap markdown-directive syntax in inline code block
slorber Sep 2, 2023
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
12 changes: 6 additions & 6 deletions docs/alertios.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,9 +132,9 @@ AlertIOS.prompt(

An Alert button type

| Type |
| ------ |
| \$Enum |
| Type |
| ----- |
| $Enum |
Comment on lines -135 to +137

@slorber slorber Sep 2, 2023

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

\$ escaping is not necessary here. The \ char appears in production for no reason IMHO.

CleanShot 2023-09-02 at 17 03 44@2x CleanShot 2023-09-02 at 17 03 58@2x

Note: this page seems to use Flow types and should probably be migrated to TypeScript. I only focused on removing the useless \ which afaik is not relevant to Flow.


**Constants:**

Expand All @@ -151,9 +151,9 @@ An Alert button type

An Alert button style

| Type |
| ------ |
| \$Enum |
| Type |
| ----- |
| $Enum |

**Constants:**

Expand Down
20 changes: 17 additions & 3 deletions docs/button.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,9 +186,23 @@ See the [Accessibility guide](accessibility.md#accessibility-actions) for more i

Color of the text (iOS), or background color of the button (Android).

| Type | Default |
| --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [color](colors) | <ins style={{background: '#2196F3'}} className="color-box" /> `'#2196F3'` <div className="label android">Android</div><hr/><ins style={{background: '#007AFF'}} className="color-box" /> `'#007AFF'` <div className="label ios">iOS</div> |
```mdx-code-block
export function ColorDefaults() {
return (
<>
<ins style={{ background: "#2196F3" }} className="color-box" />{" "}<code>'#2196F3'</code>
{" "}<div className="label android">Android</div>
<hr />
<ins style={{ background: "#007AFF" }} className="color-box" />{" "}<code>'#007AFF'</code>
{" "}<div className="label ios">iOS</div>
</>
);
}
```

| Type | Default |
| --------------- | ---------------- |
| [color](colors) | <ColorDefaults/> |
Comment on lines +189 to +205

@slorber slorber Sep 2, 2023

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

The value inside the table is quite complex and would be better migrated to a standalone React component to make it easier to maintain.

Also in MDX v1 interleaving JSX/MD is not super robust and currently one of the 2 colors was not wrapped properly in an inline code block. This change will fix it by only using JSX (using <code> instead of backticks).

I'm using mdx-code-block (Docusaurus feature) to avoid Prettier reformatting the indentation of the React component. A better solution would be to use the .mdx extension (now recommended, it's better for MDX external tooling support)

CleanShot 2023-09-02 at 17 05 26@2x CleanShot 2023-09-02 at 17 05 46@2x


---

Expand Down
290 changes: 145 additions & 145 deletions docs/colors.md
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/new-architecture-app-intro.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ You can find instructions on how to upgrade in the page [upgrading to new versio

Remember to re-install the dependencies after upgrading (run `npm install` or `yarn`).

:::important
:::info

@slorber slorber Sep 2, 2023

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

:::important is a deprecated/legacy Docusaurus admonition alias.

The blue admonition is :::note, cf documentation: https://docusaurus.io/docs/markdown-features/admonitions

This change shouldn't have any visual impact but is just some useful cleanup, because we are likely to remove the :::important alias in the future.

CleanShot 2023-09-02 at 16 49 13@2x


Whenever you have to rename some files in the `ios` folder, please **use Xcode to rename them**. This ensure that the file references are updated in the Xcode project as well. You might need to clean the build folder (**Project** → **Clean Build Folder** or <kbd>Cmd ⌘</kbd> + <kbd>Shift ⇪</kbd> + <kbd>K</kbd>) before re-building the app. If the file is renamed outside of Xcode, you may need to click on the old `.m` file reference and Locate the new file.

Expand Down
2 changes: 1 addition & 1 deletion docs/the-new-architecture/backward-compatibility-fabric-components.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ While the last step is the same for all the platforms, the first two steps are d

## Configure the Fabric Native Component Dependencies

### <a name="dependencies-ios" />iOS
### iOS {#dependencies-ios}

@slorber slorber Sep 2, 2023

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Production bug

It seems the intent of this <a name="dependencies-ios"> tag is to create a custom anchor that you can link to from somewhere else in the page.

Considering the page contains 2 iOS headings, there's some kind of anchor conflict here and the need to distinguish them.

Unfortunately this leads to a weird behavior in Docusaurus v2, currently being visible in production: the iOS TOC item disappears mysteriously after React hydration:
https://reactnative.dev/docs/the-new-architecture/backward-compatibility-fabric-components

CleanShot.2023-09-02.at.16.52.04.mp4

Also when you don't reload the page but navigate, the iOS TOC items remains visible, but is blue for unexpected reasons:

CleanShot 2023-09-02 at 16 55 40@2x

This bug is in production, but will be automatically fixed by the Docusaurus v3 upgrade due to how differently it processes headings and generates the TOC.
cf Docusaurus v3 preview: https://deploy-preview-3780--react-native.netlify.app/docs/the-new-architecture/backward-compatibility-fabric-components)

A better way

But, the thing is: if you want to specific a custom anchor name like #dependencies-ios, you don't need to use such trick because Docusaurus provides this feature out of the box, just add {#dependencies-ios} at the end of the heading.

https://docusaurus.io/docs/markdown-features/toc#heading-ids

Before: https://reactnative.dev/docs/the-new-architecture/backward-compatibility-fabric-components#dependencies-ios

CleanShot 2023-09-02 at 17 08 05@2x

After: https://deploy-preview-3843--react-native.netlify.app/docs/the-new-architecture/backward-compatibility-fabric-components#dependencies-ios

CleanShot 2023-09-02 at 17 08 16@2x


The Apple platform installs Fabric Native Components using [CocoaPods](https://cocoapods.org) as a dependency manager.

Expand Down
2 changes: 1 addition & 1 deletion docs/the-new-architecture/backward-compatibility-turbomodules.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ While the last step is the same for all the platforms, the first two steps are d

## Configure the Turbo Native Module Dependencies

### <a name="dependencies-ios" />iOS
### iOS {#dependencies-ios}

@slorber slorber Sep 2, 2023

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Same


The Apple platform installs Turbo Native Modules using [CocoaPods](https://cocoapods.org) as a dependency manager.

Expand Down
2 changes: 1 addition & 1 deletion docs/touchablenativefeedback.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ static SelectableBackgroundBorderless(
): ThemeAttributeBackgroundPropType;
```

Creates an object that represent android theme's default background for borderless selectable elements (?android:attr/selectableItemBackgroundBorderless). Available on android API level 21+. `rippleRadius` parameter controls the radius of the ripple effect.
Creates an object that represent android theme's default background for borderless selectable elements (`?android:attr/selectableItemBackgroundBorderless`). Available on android API level 21+. `rippleRadius` parameter controls the radius of the ripple effect.

@slorber slorber Sep 2, 2023

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

This is a follow-up of a change already reviewed/accepted/merged in this other PR: #3830 (comment)

I simply missed the fact that the doc had 2 cases to fix, and only fixed one of them (which is 12 lines above).

Before: https://reactnative.dev/docs/touchablenativefeedback#methods

CleanShot 2023-09-02 at 17 10 16@2x

After: https://deploy-preview-3843--react-native.netlify.app/docs/touchablenativefeedback#methods

CleanShot 2023-09-02 at 17 10 35@2x


---

Expand Down
12 changes: 6 additions & 6 deletions website/versioned_docs/version-0.70/alertios.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,9 +132,9 @@ AlertIOS.prompt(

An Alert button type

| Type |
| ------ |
| \$Enum |
| Type |
| ----- |
| $Enum |

**Constants:**

Expand All @@ -151,9 +151,9 @@ An Alert button type

An Alert button style

| Type |
| ------ |
| \$Enum |
| Type |
| ----- |
| $Enum |

**Constants:**

Expand Down
20 changes: 17 additions & 3 deletions website/versioned_docs/version-0.70/button.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -178,9 +178,23 @@ See the [Accessibility guide](accessibility.md#accessibility-actions) for more i

Color of the text (iOS), or background color of the button (Android).

| Type | Default |
| --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [color](colors) | <ins style={{background: '#2196F3'}} className="color-box" /> `'#2196F3'` <div className="label android">Android</div><hr/><ins style={{background: '#007AFF'}} className="color-box" /> `'#007AFF'` <div className="label ios">iOS</div> |
```mdx-code-block
export function ColorDefaults() {
return (
<>
<ins style={{ background: "#2196F3" }} className="color-box" />{" "}<code>'#2196F3'</code>
{" "}<div className="label android">Android</div>
<hr />
<ins style={{ background: "#007AFF" }} className="color-box" />{" "}<code>'#007AFF'</code>
{" "}<div className="label ios">iOS</div>
</>
);
}
```

| Type | Default |
| --------------- | ---------------- |
| [color](colors) | <ColorDefaults/> |

---

Expand Down
Loading