Skip to content

Address day: docs and site links #115

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

Draft
bdbarnett wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Address day: docs and site links #115

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions data/repos_db.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -508,7 +508,7 @@
},
{
"label": "Gallery",
"href": "https://pydevices.github.io/gallery/pyscript/",
"href": "https://gallery.omnipython.org/pyscript/",
"tier_color": true
}
]
Expand Down Expand Up @@ -820,7 +820,7 @@
},
{
"label": "Gallery",
"href": "https://pydevices.github.io/gallery/gallery/",
"href": "https://gallery.omnipython.org/",
"tier_color": true
},
{
Expand Down Expand Up @@ -894,7 +894,7 @@
},
{
"label": "Gallery",
"href": "https://pydevices.github.io/gallery/gallery/",
"href": "https://gallery.omnipython.org/",
"tier_color": true
},
{
Expand Down Expand Up @@ -958,7 +958,7 @@
},
{
"label": "Live App",
"href": "https://pydevices.github.io/workbench/",
"href": "https://workbench.pydevices.com/",
"tier_color": true
},
{
Expand Down
4 changes: 2 additions & 2 deletions data/stack.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@
"entries": [
{"name": "OmniPython firmware", "group": "firmware", "does": "Build MicroPython-compatible and CircuitPython-compatible firmware with the C modules below compiled in, for boards, desktops and the browser.", "repo": "micropython-pydevices", "path": "README.md", "get": ["clone"], "runs": "Boards, Desktop, Web"},
{"name": "mpftp", "group": "firmware", "does": "Move files, run code, open the REPL, install packages and flash firmware, from VS Code, a browser tab or a terminal.", "repo": "mpftp", "path": "README.md", "get": ["pip:pydevices-mpftp"], "runs": "Desktop, Web"},
{"name": "Workbench", "group": "firmware", "does": "Edit and run MicroPython in a browser, in a built-in simulator or on a real board over USB, Bluetooth or WebREPL.", "repo": "workbench", "path": "README.md", "web": "https://pydevices.github.io/workbench/", "get": ["open"], "runs": "Web"},
{"name": "Workbench", "group": "firmware", "does": "Edit and run MicroPython in a browser, in a built-in simulator or on a real board over USB, Bluetooth or WebREPL.", "repo": "workbench", "path": "README.md", "web": "https://workbench.pydevices.com/", "get": ["open"], "runs": "Web"},
{"name": "Board configs", "group": "firmware", "does": "Describe one board's display, touch, audio and pins, so a program runs on it unchanged. There is one per board.", "repo": "pydevices", "path": "board_configs", "guide": "docs/boards/board-configs.md", "get": ["boardmip"], "runs": "MP, CP, Desktop"},
{"name": "omip", "group": "firmware", "does": "Install a package on a board in one line, with what it needs from micropython-lib, after getting the board online if it isn't.", "repo": "pydevices", "path": "lib/omip.py", "guide": "docs/guides/bring-up-a-board.md", "get": ["mip:pydevices", "pip:pydevices", "firmware"], "runs": "MP, CP, Desktop"},
{"name": "boarddev", "group": "firmware", "does": "Bring up a board's extra devices, such as its camera or sensors, only when you ask for them.", "repo": "pydevices", "path": "lib/boarddev.py", "guide": "docs/boards/board-contract.md", "get": ["mip:pydevices", "pip:pydevices", "firmware"], "runs": "MP, CP, Desktop, Web, Android"},
Expand Down Expand Up @@ -212,7 +212,7 @@
{"name": "android-template", "group": "hosts", "does": "Start your own Android app and build it into an APK.", "repo": "android-template", "path": "README.md", "get": ["template"], "runs": "Android"},
{"name": "pyscript-template", "group": "hosts", "does": "Start an installable browser app that works offline.", "repo": "pyscript-template", "path": "README.md", "get": ["template"], "runs": "Web"},

{"name": "Gallery", "group": "apps", "does": "Try a piano, a spectrum analyzer, games, dashboards, a TV remote and more, on any host.", "repo": "gallery", "path": "README.md", "web": "https://pydevices.github.io/gallery/", "get": ["open"], "runs": "MP, CP, Desktop, Web, Android"},
{"name": "Gallery", "group": "apps", "does": "Try a piano, a spectrum analyzer, games, dashboards, a TV remote and more, on any host.", "repo": "gallery", "path": "README.md", "web": "https://gallery.omnipython.org/", "get": ["open"], "runs": "MP, CP, Desktop, Web, Android"},
{"name": "Synth Station", "group": "apps", "does": "Pick an instrument and play it from a MIDI keyboard, with a front panel for its knobs and patches.", "repo": "apps", "path": "apps/synthstation", "get": ["clone"], "runs": "MP, Desktop, Web"},
{"name": "Ostinato", "group": "apps", "does": "Sequence patterns and edit songs in a groovebox.", "repo": "apps", "path": "apps/ostinato", "guide": "docs/guides/run-ostinato.md", "get": ["clone"], "runs": "Desktop, Web"},
{"name": "Vamp", "group": "apps", "does": "Run a groovebox on a board with no screen of its own.", "repo": "apps", "path": "apps/vamp", "guide": "docs/guides/put-vamp-on-a-board.md", "get": ["clone"], "runs": "MP"},
Expand Down
4 changes: 2 additions & 2 deletions docs-site/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,9 +54,9 @@ listed in [Projects](projects/index.md).

## Try it before you install it

The [gallery](https://pydevices.github.io/gallery/gallery/) runs
The [gallery](https://gallery.omnipython.org/) runs
the same example programs that run on boards, in your browser, and
[Workbench](https://pydevices.github.io/workbench/) is an editor with a
[Workbench](https://workbench.pydevices.com/) is an editor with a
simulated board built in. The main page of each project here also carries a
live demo you can edit and run.

Expand Down
4 changes: 2 additions & 2 deletions docs-site/install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,8 @@ Current releases are on TestPyPI, which is why the command names it first.
:::

:::{tab-item} In the browser
Nothing to install: the [gallery](https://pydevices.github.io/gallery/gallery/)
and [Workbench](https://pydevices.github.io/workbench/) run MicroPython as
Nothing to install: the [gallery](https://gallery.omnipython.org/)
and [Workbench](https://workbench.pydevices.com/) run MicroPython as
WebAssembly. To use a library from your own page, load it with micropip in
Pyodide or PyScript; each project's page shows the line.
:::
Expand Down
2 changes: 1 addition & 1 deletion docs-site/newcomers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ order most people meet them in.

## 1. Watch it run

Open the [gallery](https://pydevices.github.io/gallery/gallery/).
Open the [gallery](https://gallery.omnipython.org/).
Every program there is a real PyDevices example running as MicroPython in your
browser, with the same code a board would run. Pick one that draws, one that
reacts to the mouse and one that uses widgets, and read the code beside it.
Expand Down
2 changes: 1 addition & 1 deletion docs-site/projects/gallery.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ Example programs for every part of PyDevices, the board configurations they run

[gallery on GitHub](https://github.com/PyDevices/gallery).

Try them in the [gallery](https://pydevices.github.io/gallery/gallery/).
Try them in the [gallery](https://gallery.omnipython.org/).
2 changes: 1 addition & 1 deletion docs-site/projects/workbench.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@

A ViperIDE fork with a built-in WebAssembly MicroPython simulator. Edit, run and debug PyDevices code against a simulated board in your browser, with no hardware.

[Open workbench](https://pydevices.github.io/workbench/).
[Open workbench](https://workbench.pydevices.com/).

The source is on [GitHub](https://github.com/PyDevices/workbench).
2 changes: 1 addition & 1 deletion docs/reference/github-org.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ doesn't repeat it.
| Read the shared contribution guidelines | [CONTRIBUTING.md](../../CONTRIBUTING.md) |
| Read the organization's profile | [profile/README.md](../../profile/README.md), shown on [github.com/PyDevices](https://github.com/PyDevices) |
| Read a library's manual | The project's Read the Docs site, for example [pygraphics.readthedocs.io](https://pygraphics.readthedocs.io); the [documentation overview](https://pydevices.readthedocs.io) links the rest |
| Try the libraries without installing | The [PyScript gallery](https://pydevices.github.io/gallery/pyscript/) |
| Try the libraries without installing | The [PyScript gallery](https://gallery.omnipython.org/pyscript/) |
| Find board and driver documentation | [pydevices `docs/`](https://github.com/PyDevices/pydevices/tree/main/docs) |

## Discussions and issues
Expand Down
Loading