Skip to content

Commit b403a7a

Browse files
committed
fix docs linkcheck
1 parent 49eb4a9 commit b403a7a

10 files changed

Lines changed: 12 additions & 91 deletions

‎CODE_OF_CONDUCT.md‎

Lines changed: 0 additions & 76 deletions
This file was deleted.

‎docs/src/about/community.md‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,6 @@ Discussions is the front door, not Issues. The repository's issue-template confi
3030

3131
## Code of conduct
3232

33-
Participation is governed by the [Contributor Covenant code of conduct](https://github.com/reactive-python/reactpy/blob/main/CODE_OF_CONDUCT.md), which lives at the repository root. It applies everywhere the project is discussed — Discussions, Issues, pull requests, Discord, and any other space where ReactPy maintainers show up.
34-
3533
The practical version: assume good faith, criticise code rather than people, and accept that "this is obvious" is rarely true of the person asking. The enforcement section of the document names the contact route for escalating a problem.
3634

3735
## Packages outside this repository
@@ -68,7 +66,6 @@ Most unanswered questions are unanswered because they cannot be reproduced. Four
6866

6967
- Ask in [Discussions](https://github.com/reactive-python/reactpy/discussions); open an issue only for a confirmed defect.
7068
- Real-time chat is on [Discord](https://discord.gg/uNb5P4hA9X); follow up anything durable in Discussions so it stays searchable.
71-
- The [code of conduct](https://github.com/reactive-python/reactpy/blob/main/CODE_OF_CONDUCT.md) governs every one of those spaces.
7269
- Integration packages live in sibling repos; file bugs against the repo that owns the behaviour.
7370
- Reproducible reports get answers: versions, smallest failing snippet, and the server log.
7471

‎docs/src/learn/add-react-to-an-existing-project.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ The exact approach depends on your existing page setup, so let's walk through so
3434

3535
### Using ASGI Middleware
3636

37-
ReactPy supports running as middleware for any existing ASGI application. ReactPy components are embedded into your existing HTML templates using Jinja2. You can use any ASGI framework, however for demonstration purposes we have selected [Starlette](https://www.starlette.io/) for the example below.
37+
ReactPy supports running as middleware for any existing ASGI application. ReactPy components are embedded into your existing HTML templates using Jinja2. You can use any ASGI framework, however for demonstration purposes we have selected [Starlette](https://starlette.dev/) for the example below.
3838

3939
First, install ReactPy, Starlette, and your preferred ASGI webserver.
4040

@@ -44,7 +44,7 @@ First, install ReactPy, Starlette, and your preferred ASGI webserver.
4444
pip install reactpy[asgi,jinja] starlette uvicorn[standard]
4545
```
4646

47-
Next, configure your ASGI framework to use ReactPy's Jinja2 template tag. The method for doing this will vary depending on the ASGI framework you are using. Below is an example that follow's [Starlette's documentation](https://www.starlette.io/templates/):
47+
Next, configure your ASGI framework to use ReactPy's Jinja2 template tag. The method for doing this will vary depending on the ASGI framework you are using. Below is an example that follow's [Starlette's documentation](https://starlette.dev/templates/):
4848

4949
!!! abstract "Note"
5050

@@ -132,4 +132,4 @@ Plotly Dash is a web application framework that is used to create interactive da
132132
133133
If you're new to Plotly Dash, check out the [Plotly Dash tutorial](https://dash.plotly.com/installation).
134134
135-
ReactPy has unique [configuration instructions](https://github.com/reactive-python/reactpy-dash#readme) to use Plotly Dash. -->
135+
ReactPy has unique `reactpy-dash` configuration instructions to use Plotly Dash. -->

‎docs/src/learn/creating-a-react-app.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ These standalone executors are the easiest way to get started with ReactPy, as t
1818

1919
**Standalone ReactPy requires a server**
2020

21-
In order to serve the initial HTML page, you will need to run a server. The ASGI examples below use [Uvicorn](https://www.uvicorn.org/), but you can use [any ASGI server](https://github.com/florimondmanca/awesome-asgi#servers).
21+
In order to serve the initial HTML page, you will need to run a server. The ASGI examples below use [Uvicorn](https://uvicorn.dev/), but you can use [any ASGI server](https://github.com/florimondmanca/awesome-asgi#servers).
2222

2323
Executors on this page can either support client-side rendering ([CSR](https://developer.mozilla.org/en-US/docs/Glossary/CSR)) or server-side rendering ([SSR](https://developer.mozilla.org/en-US/docs/Glossary/SSR)).
2424

‎docs/src/learn/editor-setup.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ A properly configured editor can make code clearer to read and faster to write.
1717

1818
Other popular text editors used in the React community include:
1919

20-
- [Sublime Text](https://www.sublimetext.com/) has support for [syntax highlighting](https://stackoverflow.com/a/70960574/458193) and autocomplete built in.
20+
- [Sublime Text](https://www.sublimetext.com/) has support for [syntax highlighting](https://www.sublimetext.com/docs/syntax.html) and autocomplete built in.
2121
- [Vim](https://www.vim.org/) is a highly configurable text editor built to make creating and changing any kind of text very efficient. It is included as "vi" with most UNIX systems and with Apple OS X.
2222

2323
## Recommended text editor features

‎docs/src/learn/keeping-components-pure.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Some Python functions are _pure._ Pure functions only perform a calculation and
1414

1515
## Purity: Components as formulas
1616

17-
In computer science (and especially the world of functional programming), [a pure function](https://wikipedia.org/wiki/Pure_function) is a function with the following characteristics:
17+
In computer science (and especially the world of functional programming), [a pure function](https://en.wikipedia.org/wiki/Pure_function) is a function with the following characteristics:
1818

1919
- **It minds its own business.** It does not change any objects or variables that existed before it was called.
2020
- **Same inputs, same output.** Given the same inputs, a pure function should always return the same result.

‎docs/src/learn/passing-props-to-a-component.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Props are the information that you pass to a tag. For example, `#!python classNa
3636
# TODO
3737
```
3838

39-
The props you can pass to an `#!python html.img` tag are predefined (the browser conforms to [the HTML standard](https://www.w3.org/TR/html52/semantics-embedded-content.html#the-img-element)), and they keep their familiar camelCase spelling because they are handed straight to the DOM. But you can pass any props to _your own_ components, such as `#!python avatar()`, to customize them. Here's how!
39+
The props you can pass to an `#!python html.img` tag are predefined (the browser conforms to [the HTML standard](https://html.spec.whatwg.org/multipage/embedded-content.html#the-img-element)), and they keep their familiar camelCase spelling because they are handed straight to the DOM. But you can pass any props to _your own_ components, such as `#!python avatar()`, to customize them. Here's how!
4040

4141
## Passing props to a component
4242

‎docs/src/learn/react-developer-tools.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Now, if you visit a website **built with React,** you will see the _Components_
3232
3333
### Safari and other browsers
3434
35-
For other browsers (for example, Safari), install the [`react-devtools`](https://www.npmjs.com/package/react-devtools) npm package:
35+
For other browsers (for example, Safari), install the [`react-devtools`](https://github.com/facebook/react/tree/main/packages/react-devtools) npm package:
3636
3737
```bash
3838
# Yarn

‎docs/src/learn/responding-to-events.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -183,7 +183,7 @@ Here, `#!python toolbar()` renders a `#!python play_button()` and an `#!python u
183183

184184
Finally, the `#!python button()` component accepts a prop called `#!python on_click` and passes it straight to the built-in browser button with `#!python {"onClick": on_click}`. This tells ReactPy to call the passed function on click.
185185

186-
Notice the two levels of naming: the prop your own component accepts is an ordinary Python parameter (`#!python on_click`, snake_case), while the key handed to the browser tag is `#!python "onClick"`. A [design system](https://uxdesign.cc/everything-you-need-to-know-about-design-systems-54b109851969) commonly puts styling in components like buttons but leaves the behavior to callers, so `#!python play_button()` and `#!python upload_button()` pass handlers down.
186+
Notice the two levels of naming: the prop your own component accepts is an ordinary Python parameter (`#!python on_click`, snake_case), while the key handed to the browser tag is `#!python "onClick"`. A [design system](https://en.wikipedia.org/wiki/Design_system) commonly puts styling in components like buttons but leaves the behavior to callers, so `#!python play_button()` and `#!python upload_button()` pass handlers down.
187187

188188
### Naming event handler props
189189

‎docs/src/learn/writing-markup-with-psx.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -187,9 +187,9 @@ For historical reasons, [`aria-*`](https://developer.mozilla.org/docs/Web/Access
187187
188188
</Pitfall>
189189
190-
### Pro-tip: Use a PSX Converter
190+
### Pro-tip: There Is No PSX Converter (Yet)
191191
192-
Converting all these attributes in existing markup can be tedious! We recommend using a [converter](https://transform.tools/html-to-psx) to translate your existing HTML and SVG to PSX. Converters are very useful in practice, but it's still worth understanding what is going on so that you can comfortably write PSX on your own.
192+
Converting all these attributes in existing markup can be tedious! There is no converter that translates your existing HTML and SVG to PSX yet — PSX is still planned (see [this issue](https://github.com/reactive-python/reactpy/issues/918)). Until one exists, you will need to translate markup by hand, so it's worth understanding what is going on in order to comfortably write PSX on your own.
193193
194194
Here is your final result:
195195
@@ -224,7 +224,7 @@ img {
224224
Now you know why PSX exists and how to use it in components:
225225
226226
- React components group rendering logic together with markup because they are related.
227-
- PSX is similar to HTML, with a few differences. You can use a [converter](https://transform.tools/html-to-psx) if you need to.
227+
- PSX is similar to HTML, with a few differences.
228228
- Error messages will often point you in the right direction to fixing your markup.
229229
230230
</Recap>

0 commit comments

Comments
 (0)