Skip to content

Commit de8b706

Browse files
authored
docs: categorization (#276)
* docs: rename categories to be more descriptive * fix(docs): invalid typing in Swift docs * fix(docs): broken links
1 parent e174e50 commit de8b706

File tree

8 files changed

+17
-15
lines changed

8 files changed

+17
-15
lines changed

docs/docs/docs/api-reference/_meta.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,16 @@
22
{
33
"type": "dir",
44
"name": "react-native-brownfield",
5-
"label": "ReactNativeBrownfield"
5+
"label": "iOS & Android integration"
66
},
77
{
88
"type": "dir",
9-
"name": "brownfield-navigation.mdx",
10-
"label": "BrownfieldNavigation"
9+
"name": "brownfield-navigation",
10+
"label": "Navigation"
1111
},
1212
{
1313
"type": "dir",
1414
"name": "brownie",
15-
"label": "Brownie"
15+
"label": "State Management"
1616
}
1717
]

docs/docs/docs/api-reference/brownfield-navigation.mdx/_meta.json renamed to docs/docs/docs/api-reference/brownfield-navigation/_meta.json

File renamed without changes.

docs/docs/docs/api-reference/brownfield-navigation.mdx/brownfield-navigation.mdx renamed to docs/docs/docs/api-reference/brownfield-navigation/brownfield-navigation.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@ You define a TypeScript contract once, generate native bridge files, and impleme
1313

1414
## Guides
1515

16-
- [Setup and Codegen](/docs/api-reference/brownfield-navigation.mdx/setup-and-codegen)
17-
- [Native Integration](/docs/api-reference/brownfield-navigation.mdx/native-integration)
18-
- [JavaScript Usage](/docs/api-reference/brownfield-navigation.mdx/javascript-usage)
16+
- [Setup and Codegen](/docs/api-reference/brownfield-navigation/setup-and-codegen)
17+
- [Native Integration](/docs/api-reference/brownfield-navigation/native-integration)
18+
- [JavaScript Usage](/docs/api-reference/brownfield-navigation/javascript-usage)
1919

2020
## Example Projects
2121

docs/docs/docs/api-reference/brownfield-navigation.mdx/javascript-usage.mdx renamed to docs/docs/docs/api-reference/brownfield-navigation/javascript-usage.mdx

File renamed without changes.

docs/docs/docs/api-reference/brownfield-navigation.mdx/native-integration.mdx renamed to docs/docs/docs/api-reference/brownfield-navigation/native-integration.mdx

File renamed without changes.

docs/docs/docs/api-reference/brownfield-navigation.mdx/setup-and-codegen.mdx renamed to docs/docs/docs/api-reference/brownfield-navigation/setup-and-codegen.mdx

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -39,9 +39,11 @@ export interface BrownfieldNavigationSpec {
3939

4040
:::info
4141
Prefer simple synchronous navigation methods (`void`).
42-
<br/>
43-
Async Promise-based methods are not currently supported by the generated native code on iOS and Android — they will compile, but the generated implementations will reject with a `not_implemented` error.
44-
:::
42+
43+
<br />
44+
Async Promise-based methods are not currently supported by the generated native
45+
code on iOS and Android — they will compile, but the generated implementations
46+
will reject with a `not_implemented` error. :::
4547

4648
## 2) Run codegen
4749

@@ -74,5 +76,5 @@ Then recompile native apps.
7476

7577
## Next
7678

77-
- Continue with [Native Integration](/docs/api-reference/brownfield-navigation.mdx/native-integration)
78-
- Then wire JS calls from [JavaScript Usage](/docs/api-reference/brownfield-navigation.mdx/javascript-usage)
79+
- Continue with [Native Integration](/docs/api-reference/brownfield-navigation/native-integration)
80+
- Then wire JS calls from [JavaScript Usage](/docs/api-reference/brownfield-navigation/javascript-usage)

docs/docs/docs/api-reference/react-native-brownfield/swift.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ ReactNativeBrownfield.shared
3030

3131
| Property | Type | Default | Description |
3232
| ------------------- | --------------- | --------------- | ---------------------------------------------------------------------------------------------- |
33-
| `entryFile` | `NSString` | `index` | Path to JavaScript entry file in development. |
33+
| `entryFile` | `String` | `index` | Path to JavaScript entry file in development. |
3434
| `bundlePath` | `String` | `main.jsbundle` | Path to JavaScript bundle file. |
3535
| `bundle` | `Bundle` | `Bundle.main` | Bundle instance to lookup the JavaScript bundle resource. |
3636
| `bundleURLOverride` | `(() -> URL?)?` | `nil` | Dynamic bundle URL provider called on every bundle load. When set, overrides default behavior. |

docs/docs/docs/cli/introduction.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,5 @@ Technically, the CLI itself is encapsulated in the `@callstack/brownfield-cli` p
1010

1111
Please refer to the appropriate pages for detailed usage instructions for each of the ecosystem packages:
1212

13-
- [`@callstack/react-native-brownfield` - Brownfield library commands](./brownfield)
14-
- [`@callstack/brownie` - Brownie state management library commands](./brownie)
13+
- [iOS & Android integration](./brownfield)`@callstack/react-native-brownfield` commands
14+
- [State Management](./brownie)`@callstack/brownie` commands

0 commit comments

Comments
 (0)