docs(mkdocs): add run instructions to the navigation example - #63
owenthcarey merged 3 commits into
Conversation
Sorry, something went wrong.
owenthcarey
left a comment
There was a problem hiding this comment.
Thanks, this is nearly there. Two small accuracy fixes before I merge (inline below). Everything else looks good, and thanks for verifying with mkdocs build --strict.
Sorry, something went wrong.
|
|
||
| Paste any of the snippets below into `app/main.py` of a project | ||
| scaffolded with `pn init`, then run `pn preview` (or `pn run android` | ||
| / `pn run ios`). The Stack, Tab, and Drawer examples define `App` |
There was a problem hiding this comment.
Only the Stack snippet actually runs as is. The Tab and Drawer snippets don't include import pythonnative as pn, so pasting either one alone into app/main.py fails with NameError: name 'pn' is not defined.
Could you either add the import line to those two code blocks (the Counter and Forms examples each carry their own import, so that matches the rest of the docs), or reword this sentence so readers know to add it?
Sorry, something went wrong.
|
|
||
| This snippet sketches the composition rather than a complete app: | ||
| `Feed` is defined in the Tab navigator example above, and `Post` | ||
| isn't shown. To try it, add a `Post` screen and use this `App` in |
There was a problem hiding this comment.
ProfileStack is also undefined here, not just Post. Someone who adds a Post screen as instructed will still hit a NameError on ProfileStack. Please mention it too, for example "Post and ProfileStack aren't shown."
Sorry, something went wrong.
What
docs/examples/navigation.md had five code snippets but never said
how to run them. This adds that.
Changes
app/main.py, run pn preview (or pn run android / pn run ios). Covers Stack, Tab, and Drawer, which each define a runnable
App.
referenced but never defined) and what to add to run it.
(the dotted-component syntax from the desktop preview
guide), since
CameraScreen isn't wrapped in a navigator.
Verification
pn preview renders it following only the new instructions.
Closes #60