Skip to content

Rewrite the docs #1052

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

Open
Archmonger wants to merge 178 commits into
base: main
Choose a base branch
from
Open

Rewrite the docs #1052

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
178 commits
Select commit Hold shift + click to select a range
d0e3628
`Archmonger/reactpy-docs/main` to `reactive-python/reactpy/new-docs`
Archmonger Jun 14, 2023
8602fff
add gh pages publishing workflow
Archmonger Jun 14, 2023
b05c29c
fix requirements path
Archmonger Jun 14, 2023
3b5341a
update github pages link
Archmonger Jun 14, 2023
2b5dd4d
update site description
Archmonger Jun 15, 2023
8cc75aa
minor typos
Archmonger Jun 16, 2023
a05cbe0
setup for the tutorial section
Archmonger Jun 16, 2023
2f5b68a
switch from abstract to note admonitiion
Archmonger Jun 16, 2023
308d216
reword note
Archmonger Jun 16, 2023
838671b
cell-var-from-loop
Archmonger Jun 18, 2023
58bac05
update readme
Archmonger Jun 19, 2023
ad10c29
add padding to sidebar nav
Archmonger Jun 19, 2023
73dadc9
Inspecting the starter code
Archmonger Jun 19, 2023
f28a6ab
Add disclaimer about unfinished pages
Archmonger Jun 19, 2023
60d54e0
rename tic-tac-toe folder
Archmonger Jun 19, 2023
0a347dd
add styling utils
Archmonger Jun 19, 2023
acf3f5c
build a static version in React
Archmonger Jun 19, 2023
e4be299
Find the minimal but complete representation of UI state
Archmonger Jun 19, 2023
067279f
Identify where your state should live
Archmonger Jun 19, 2023
3a0d107
Thinking in React
Archmonger Jun 19, 2023
865c18f
Add fixme
Archmonger Jun 19, 2023
6195050
start a new react project
Archmonger Jun 19, 2023
fa4b1df
Add in progress warnings
Archmonger Jun 19, 2023
3c0b071
Add more in progress warnings
Archmonger Jun 19, 2023
ce60b29
a little bit of the "responding to events" section
Archmonger Jun 20, 2023
656623a
remove start from the runnable examples
Archmonger Jun 20, 2023
3c644cc
more in progress warnings
Archmonger Jun 20, 2023
fe45c54
add stub docs for hooks
Archmonger Jun 20, 2023
3de3fd3
add use-id warning
Archmonger Jun 20, 2023
3aab58b
Add undeveloped hooks
Archmonger Jun 20, 2023
8f58f8c
mkdocs-section-index: Move titles to mkdocs.yml
Archmonger Jun 21, 2023
c2c0281
verbiage on installation docs
Archmonger Jun 21, 2023
aec77d4
add installation index page
Archmonger Jun 21, 2023
7c68a47
editor setup
Archmonger Jun 21, 2023
302f133
remove unneeded space
Archmonger Jun 21, 2023
11aa58a
format everything
Archmonger Jun 21, 2023
ab653c5
Add extras section
Archmonger Jun 27, 2023
64432b2
Cleanup blocked pages
Archmonger Jun 30, 2023
260b5e5
change undeveloped warning text
Archmonger Jun 30, 2023
1ffc0d9
add pyscript backend
Archmonger Jul 13, 2023
106a128
add mike
Archmonger Aug 27, 2023
b505d03
sync styles to django
Archmonger Aug 27, 2023
c9964f6
Change you will learn" capitalization
Archmonger Aug 28, 2023
5ed1300
Change note to abstract
Archmonger Jan 5, 2024
0a36534
html can now return none
Archmonger Jan 5, 2024
2bef10d
unbork large portions of the theme
Archmonger Mar 14, 2025
169e33e
delete python src from this branch
Archmonger Mar 14, 2025
fb84879
ReactPy V2 changes
Archmonger Mar 15, 2025
1e93576
fix a few pages
Archmonger Mar 15, 2025
5ee7998
add tools and packages section, remove outdated references, and fix J…
Archmonger Mar 16, 2025
30b6654
refine tutorial instructions and update language for clarity
Archmonger Mar 16, 2025
b295d7b
bump gitignore
Archmonger Jun 15, 2025
79d6edf
docs: clear lint and typecheck baseline for doc examples
Archmonger Oct 5, 2026
4c46c68
docs(learn): rewrite "Your First Component" for ReactPy
Archmonger Oct 5, 2026
b2c55b3
docs: add inline syntax highlighting to completed Learn pages
Archmonger Oct 5, 2026
773d1ff
docs(learn): rewrite "Importing and Exporting Components" for ReactPy
Archmonger Oct 5, 2026
8e8fe51
docs: add AGENT_CONTEXT.md reference for ReactPy v2 doc work
Archmonger Oct 5, 2026
e7ae1a9
docs(learn): rewrite "Passing Props to a Component" for ReactPy
Archmonger Oct 5, 2026
d41180f
docs: record use_async_effect zero-argument contract in AGENT_CONTEXT
Archmonger Oct 5, 2026
db287d9
docs(learn): rewrite "Conditional Rendering" for ReactPy
Archmonger Oct 5, 2026
0365e21
docs: record ReactPy boolean-child rendering in AGENT_CONTEXT
Archmonger Oct 5, 2026
cd0b448
docs(learn): rewrite "Rendering Lists" for ReactPy
Archmonger Oct 5, 2026
b9fc91e
docs(learn): rewrite "Keeping Components Pure" for ReactPy
Archmonger Oct 5, 2026
7e7f658
docs: record missing StrictMode and component-level memo in AGENT_CON…
Archmonger Oct 5, 2026
8aa7f7c
docs(learn): rewrite "Responding to Events" for ReactPy
Archmonger Oct 5, 2026
cf69e3d
docs(learn): rewrite "Render and Commit" for ReactPy
Archmonger Oct 5, 2026
10a35db
docs(learn): rewrite "Queueing a Series of State Updates" for ReactPy
Archmonger Oct 5, 2026
6300f1f
docs(reference): record verified state-update and event semantics
Archmonger Oct 5, 2026
9566f11
docs(learn): drop disproved FIXME from thinking-in-react
Archmonger Oct 5, 2026
ec81e47
docs(learn): rewrite "State as a Snapshot" for ReactPy
Archmonger Oct 5, 2026
ac89c1b
docs(learn): rewrite "Updating Objects in State" for ReactPy
Archmonger Oct 5, 2026
680203e
docs(learn): rewrite "Updating Arrays in State" for ReactPy
Archmonger Oct 5, 2026
7a77694
docs(reference): rewrite "Use State" for ReactPy
Archmonger Oct 5, 2026
b717597
docs(reference): rewrite "Use Effect" and "Use Async Effect" for ReactPy
Archmonger Oct 5, 2026
e54485e
docs(reference): author the three ASGI executor pages
Archmonger Oct 5, 2026
706dedf
docs(reference): rewrite the reference landing page
Archmonger Oct 5, 2026
1a234e5
docs(agent-context): record caching-hook semantics measured from source
Archmonger Oct 5, 2026
f83108d
docs(reference): port use-ref
Archmonger Oct 5, 2026
eb36dc6
docs: correct the state-update comparison claim
Archmonger Oct 5, 2026
bf6fce5
docs(reference): port use-memo
Archmonger Oct 5, 2026
6538f62
docs(reference): port use-callback
Archmonger Oct 5, 2026
5ad1fd4
docs(reference): port use-debug-value
Archmonger Oct 5, 2026
6885819
docs: record reactpy_to_string cannot render hook-using components
Archmonger Oct 5, 2026
546eedb
docs(reference): author the three connection hooks
Archmonger Oct 5, 2026
d3a86dd
docs(use-memo): tighten the decorator-form caveat
Archmonger Oct 5, 2026
80a6fd4
docs(reference): port use-reducer
Archmonger Oct 5, 2026
e67b81d
docs(reference): port use-context
Archmonger Oct 5, 2026
2f79c8b
docs(reference): port common-props and author usage
Archmonger Oct 5, 2026
127c13d
docs(reference): author the four Rules of React pages
Archmonger Oct 5, 2026
75cdb6d
docs(reference): author the Jinja template tags page
Archmonger Oct 5, 2026
075db6a
docs(reference): correct the event handler argument contract
Archmonger Oct 5, 2026
fcb5123
docs(reference): author the Protocol Structure page
Archmonger Oct 5, 2026
61dde88
docs(reference): name ASGI entry modules main.py to match uvicorn tar…
Archmonger Oct 6, 2026
cc4efe6
docs(reference): author the Client API page
Archmonger Oct 6, 2026
243d1db
docs(examples): make the naming_props handlers do something
Archmonger Oct 6, 2026
4d74388
docs: port Sharing State Between Components to ReactPy
Archmonger Oct 6, 2026
b7ac832
docs: port Referencing Values with Refs to ReactPy
Archmonger Oct 6, 2026
392e8b2
docs: port Manipulating the DOM with Refs to ReactPy
Archmonger Oct 6, 2026
fa61fd4
docs: port Preserving and Resetting State to ReactPy
Archmonger Oct 6, 2026
45113cf
docs: port State: A Component's Memory to ReactPy
Archmonger Oct 8, 2026
70194f7
docs: port Reacting to Input with State to ReactPy
Archmonger Oct 8, 2026
88b7d45
docs(learn): author the seven escape-hatch pages for ReactPy v2
Archmonger Oct 9, 2026
c22c470
docs(learn): author Synchronizing with Effects for ReactPy v2
Archmonger Oct 9, 2026
fa0f21c
docs(ci): repair the mkdocstrings inventory key
Archmonger Oct 10, 2026
d22b32c
docs(learn): author You Might Not Need an Effect for ReactPy v2
Archmonger Oct 10, 2026
48ef6a0
docs(learn): author Lifecycle of Reactive Effects for ReactPy v2
Archmonger Oct 10, 2026
5b89ec4
docs(learn): author Separating Events from Effects for ReactPy v2
Archmonger Oct 10, 2026
fdbed24
docs(learn): author Removing Effect Dependencies for ReactPy v2
Archmonger Oct 10, 2026
8c8fda6
docs(examples): fix include-marker cropping that leaked markers into …
Archmonger Oct 10, 2026
2506637
docs(learn): author Reusing Logic with Custom Hooks for ReactPy v2
Archmonger Oct 10, 2026
fac09fb
docs(learn): correct seven verified technical errors in the escape-ha…
Archmonger Oct 10, 2026
1e4a00f
docs(nav): drop the stale WIP badge from the seven escape-hatch pages
Archmonger Oct 10, 2026
d3c4c43
docs(learn): author Choosing the State Structure for ReactPy v2
Archmonger Oct 10, 2026
7ec7444
docs(nav): mark Choosing the State Structure as authored
Archmonger Oct 10, 2026
b5d868e
docs(learn): author Extracting State Logic into a Reducer for ReactPy v2
Archmonger Oct 10, 2026
9f7c40a
docs(nav): mark Extracting State Logic into a Reducer as authored
Archmonger Oct 10, 2026
10460e0
docs(learn): author Passing Data Deeply with Context for ReactPy v2
Archmonger Oct 10, 2026
cb9cadf
docs(nav): mark Passing Data Deeply with Context as authored
Archmonger Oct 10, 2026
e829967
docs(learn): author Scaling Up with Reducer and Context for ReactPy v2
Archmonger Oct 10, 2026
265ec33
docs(about): author Community, Running Tests, Contributing Code, and …
Archmonger Oct 10, 2026
bba5dea
docs(about): restore the changelog and author its page
Archmonger Oct 10, 2026
8341a17
docs(about): correct the claim that CI gates documentation changes
Archmonger Oct 10, 2026
1de4a7d
docs(learn): author Tutorial: Tic-Tac-Toe for ReactPy v2
Archmonger Oct 10, 2026
6b78a62
docs(agent): fix the create_context provider example and the hooks im…
Archmonger Oct 12, 2026
5e8226a
docs(reference): correct five claims about the package's runtime beha…
Archmonger Oct 12, 2026
287fe6b
docs(about): state what mkdocs build --strict actually fails on
Archmonger Oct 12, 2026
2da1bca
docs(about,learn): repair three dead links on published pages
Archmonger Oct 12, 2026
19071fd
docs(reference): drop the parked use_id page
Archmonger Oct 12, 2026
47a1317
docs(nav): publish the Installation overview page
Archmonger Oct 12, 2026
78f1dd0
build(docs): raise the mkdocs-material pin so the docs install on 3.12+
Archmonger Oct 12, 2026
cd74ea3
docs(theme): fix sidebar, TOC, and code-header styling
Archmonger Oct 12, 2026
1dd93b9
fix titlepage
Archmonger Oct 14, 2026
a0b90db
Update sidebar font sizes and weight
Archmonger Oct 14, 2026
95ce88d
Remove padding on tabbed labels
Archmonger Oct 14, 2026
0e1260b
Adjust sidebar font size variable to 0.75rem
Archmonger Oct 14, 2026
9c7d3bc
Enable section-index plugin in mkdocs configuration
Archmonger Oct 14, 2026
208e0aa
Update navigation structure in mkdocs.yml
Archmonger Oct 14, 2026
c5abf30
docs(learn): correct snapshot, batching, and conditional-render claims
Archmonger Oct 16, 2026
09ecbdd
docs(reference): fix hooks reference accuracy
Archmonger Oct 16, 2026
aab6f5b
docs: restore reactpy-flake8 and fix rules-of-hooks / React-isms
Archmonger Oct 16, 2026
3ee3ce5
docs(reference): fix protocol and error-reporting claims
Archmonger Oct 16, 2026
384201b
docs(learn): a ref cannot hold a DOM node
Archmonger Oct 16, 2026
3f0ce61
docs(reference): fix executor and client-api accuracy
Archmonger Oct 16, 2026
d0026fb
docs(learn): event-handler detection is by callable(), not the key pa…
Archmonger Oct 16, 2026
40dc0ca
docs(reference): make the jinja component example actually mount
Archmonger Oct 16, 2026
c5c2e10
docs(reference): fix a broken jinja anchor, reformat middleware call
Archmonger Oct 16, 2026
0decbc3
docs: fix stale CI/pin claims, a leaking include marker, and two redu…
Archmonger Oct 17, 2026
24cbacd
docs(learn): give the tic-tac-toe nine-squares step its own example
Archmonger Oct 17, 2026
5430bc9
docs: fix an inverted comment in the quiz-form example
Archmonger Oct 17, 2026
b278ab4
docs: correct what PyScript actually strips, and what dict == costs
Archmonger Oct 17, 2026
6c56313
docs(examples): make every documented handler a coroutine
Archmonger Oct 18, 2026
67652fa
docs: describe the live event proxy from #1352
Archmonger Oct 18, 2026
d4f9252
reintroduce source from `main` branch
Archmonger Oct 18, 2026
aa33aaf
Merge remote-tracking branch 'origin/main' into new-docs
Archmonger Oct 18, 2026
7e00f9b
remove old copilot instructions.md
Archmonger Oct 18, 2026
bad2177
fix license path
Archmonger Oct 18, 2026
472016a
fix home href
Archmonger Oct 18, 2026
79b422a
prep for merge
Archmonger Oct 18, 2026
ee1a453
docs linting workflow
Archmonger Oct 18, 2026
49eb4a9
rm built docs
Archmonger Oct 18, 2026
b403a7a
fix docs linkcheck
Archmonger Oct 18, 2026
9042036
update docs publishing workflow
Archmonger Oct 18, 2026
8d045ca
move test docs into correct place
Archmonger Oct 18, 2026
ba5086f
revert accidental test matrix removal
Archmonger Oct 18, 2026
5d49570
rename to AGENTS_EXTERNAL
Archmonger Oct 18, 2026
3e8fa06
Rewrite AGENTS_EXTERNAL.md as an external-app reference
Archmonger Oct 18, 2026
35dd6cb
State the rules of Hooks as runtime consequences
Archmonger Oct 18, 2026
62a21e4
Extend AGENTS_EXTERNAL.md for app authors
Archmonger Oct 18, 2026
d3bb03c
Correct docs that disagreed with the source
Archmonger Oct 18, 2026
730aa7e
disable linkcheck
Archmonger Oct 19, 2026
a3728d3
add compaction notice to agents external
Archmonger Oct 19, 2026
d273adb
update readme
Archmonger Oct 19, 2026
4ef5f0c
Functional embedded demo runner for the docs
Archmonger Oct 19, 2026
6c7ead7
Update image paths in documentation to use relative URLs
Archmonger Oct 19, 2026
099fffc
remove false refs to 1.x
Archmonger Oct 20, 2026
4fd5389
add print shim
Archmonger Oct 20, 2026
16d88e5
misc
Archmonger Oct 20, 2026
2f3702a
fix event handling in pyscript
Archmonger Oct 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
391 changes: 0 additions & 391 deletions .github/copilot-instructions.md
View file
Open in desktop

This file was deleted.

Loading
Loading