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