Skip to content

Commit 1e93576

Browse files
committed
fix a few pages
1 parent fb84879 commit 1e93576

11 files changed

+1919
-24
lines changed

Diff for: docs/mkdocs.yml

+21-24
Original file line numberDiff line numberDiff line change
@@ -11,17 +11,17 @@ nav:
1111
- Add React to an Existing Project: learn/add-react-to-an-existing-project.md
1212
- Setup:
1313
- Editor Setup: learn/editor-setup.md
14-
- React Developer Tools 🚫: learn/react-developer-tools.md
15-
- Extra Tools and Packages 🚧: learn/extra-tools-and-packages.md
16-
- More Tutorials:
17-
- "Tutorial: React Bootstrap 🚫": learn/tutorial-react-bootstrap.md
18-
- "Tutorial: Material UI 🚫": learn/tutorial-material-ui.md
14+
# - ReactPy Developer Tools 🚫: learn/react-developer-tools.md
15+
- Tools, Modules, and Packages 🚧: learn/extra-tools-and-packages.md
16+
# - More Tutorials:
17+
# - "Tutorial: React Bootstrap 🚫": learn/tutorial-react-bootstrap.md
18+
# - "Tutorial: Material UI 🚫": learn/tutorial-material-ui.md
1919
- Learn:
2020
- Describing the UI:
2121
- Your First Component 🚧: learn/your-first-component.md
2222
- Importing and Exporting Components 🚧: learn/importing-and-exporting-components.md
23-
- Writing Markup with PSX 🚫: learn/writing-markup-with-psx.md
24-
- Python in PSX with Curly Braces 🚫: learn/python-in-psx-with-curly-braces.md
23+
# - Writing Markup with PSX 🚫: learn/writing-markup-with-psx.md
24+
# - Python in PSX with Curly Braces 🚫: learn/python-in-psx-with-curly-braces.md
2525
- Passing Props to a Component 🚧: learn/passing-props-to-a-component.md
2626
- Conditional Rendering 🚧: learn/conditional-rendering.md
2727
- Rendering Lists 🚧: learn/rendering-lists.md
@@ -59,9 +59,11 @@ nav:
5959
- Creating Backends 🚧: learn/creating-backends.md
6060
- Manually Register a Client 🚧: learn/manually-register-a-client.md
6161
- Reference:
62+
- Overview: reference/overview.md
6263
- Hooks:
6364
- Use State 🚧: reference/use-state.md
6465
- Use Effect 🚧: reference/use-effect.md
66+
- Use Async Effect 🚧: reference/use-async-effect.md
6567
- Use Context 🚧: reference/use-context.md
6668
- Use Reducer 🚧: reference/use-reducer.md
6769
- Use Callback 🚧: reference/use-callback.md
@@ -71,26 +73,20 @@ nav:
7173
- Use Connection 🚧: reference/use-connection.md
7274
- Use Scope 🚧: reference/use-scope.md
7375
- Use Location 🚧: reference/use-location.md
74-
- Use ID 🚫: reference/use-id.md
75-
- Use Deferred Value 🚫: reference/use-deferred-value.md
76-
- Use Imperative Handle 🚫: reference/use-imperative-handle.md
77-
- Use Insertion Effect 🚫: reference/use-insertion-effect.md
78-
- Use Layout Effect 🚫: reference/use-layout-effect.md
79-
- Use Sync External Store 🚫: reference/use-sync-external-store.md
80-
- Use Transition 🚫: reference/use-transition.md
8176
- HTML Tags:
8277
- Common Props 🚧: reference/common-props.md
8378
- Usage 🚧: reference/usage.md
84-
- Backends:
85-
- FastAPI 🚧: reference/fastapi.md
86-
- Flask 🚧: reference/flask.md
87-
- Sanic 🚧: reference/sanic.md
88-
- Starlette 🚧: reference/starlette.md
89-
- Tornado 🚧: reference/tornado.md
90-
- Django 🚧: reference/django.md
91-
- Jupyter 🚧: reference/jupyter.md
92-
- Plotly Dash 🚧: reference/plotly-dash.md
93-
- PyScript 🚫: reference/pyscript.md
79+
- Executors:
80+
- ReactPy: reference/reactpy.md
81+
- ReactPyCsr 🚧: reference/reactpy-csr.md
82+
- ReactPyMiddleware 🚧: reference/reactpy-middleware.md
83+
- Rules of React:
84+
- Overview 🚧: reference/rules-of-react.md
85+
- Components and Hooks must be pure 🚧: reference/components-and-hooks-must-be-pure.md
86+
- React calls Components and Hooks 🚧: reference/react-calls-components-and-hooks.md
87+
- Rules of Hooks 🚧: reference/rules-of-hooks.md
88+
# - Template Tags:
89+
# - Jinja 🚧: reference/jinja.md
9490
- Protocol Structure 🚧: reference/protocol-structure.md
9591
- Client API 🚧: reference/client-api.md
9692
- About:
@@ -99,6 +95,7 @@ nav:
9995
- Running Tests 🚧: about/running-tests.md
10096
- Contributing Code 🚧: about/code.md
10197
- Contributing Documentation 🚧: about/docs.md
98+
- Licenses 🚧: about/licenses.md
10299

103100
theme:
104101
name: material
File renamed without changes.

Diff for: docs/src/reference/overview.md

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
<p class="intro" markdown>
2+
3+
This section provides detailed reference documentation for working with React. For an introduction to React, please visit the [Learn](/learn) section.
4+
5+
</p>
6+
7+
The React reference documentation is broken down into functional subsections:
8+
9+
## React
10+
11+
Programmatic React features:
12+
13+
- [Hooks](/reference/react/hooks) - Use different React features from your components.
14+
- [Components](/reference/react/components) - Built-in components that you can use in your JSX.
15+
- [APIs](/reference/react/apis) - APIs that are useful for defining components.
16+
- [Directives](/reference/rsc/directives) - Provide instructions to bundlers compatible with React Server Components.
17+
18+
## React DOM
19+
20+
React-dom contains features that are only supported for web applications (which run in the browser DOM environment). This section is broken into the following:
21+
22+
- [Hooks](/reference/react-dom/hooks) - Hooks for web applications which run in the browser DOM environment.
23+
- [Components](/reference/react-dom/components) - React supports all of the browser built-in HTML and SVG components.
24+
- [APIs](/reference/react-dom) - The `react-dom` package contains methods supported only in web applications.
25+
- [Client APIs](/reference/react-dom/client) - The `react-dom/client` APIs let you render React components on the client (in the browser).
26+
- [Server APIs](/reference/react-dom/server) - The `react-dom/server` APIs let you render React components to HTML on the server.
27+
28+
## Rules of React
29+
30+
React has idioms — or rules — for how to express patterns in a way that is easy to understand and yields high-quality applications:
31+
32+
- [Components and Hooks must be pure](/reference/rules/components-and-hooks-must-be-pure) – Purity makes your code easier to understand, debug, and allows React to automatically optimize your components and hooks correctly.
33+
- [React calls Components and Hooks](/reference/rules/react-calls-components-and-hooks) – React is responsible for rendering components and hooks when necessary to optimize the user experience.
34+
- [Rules of Hooks](/reference/rules/rules-of-hooks) – Hooks are defined using JavaScript functions, but they represent a special type of reusable UI logic with restrictions on where they can be called.
35+
36+
## Legacy APIs
37+
38+
- [Legacy APIs](/reference/react/legacy) - Exported from the `react` package, but not recommended for use in newly written code.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)