Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Isaac-Flath authored Oct 24, 2024
1 parent bce13e3 commit 12f0662
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@ Edit those, not the .py files.

## Exporting the fh-frankenui modules

This is an nbdev library. The notebooks are located in lib_nbs.
This is an [nbdev](https://nbdev.fast.ai/) library. The notebooks are located in lib_nbs.
When you run `watch_export` from the repo root, .py files are exported
into the library directory, `fh_frankenui`:

```bash
fh-frankenui % watch_export
watch_export
```

It's nice to have this constantly running in a terminal tab.
Expand All @@ -24,13 +24,13 @@ In one terminal, from the `docs/` directory you can run `watch_export` to consta
watch the notebooks, exporting Python modules from them whenever they change:

```bash
docs % watch_export --nbs . --lib app --force
watch_export --nbs . --lib app --force
```

In a second terminal, run `main.py` to run the docs locally:
In a second terminal run `main.py` in the docs directory to run the docs locally:

```bash
docs % python main.py
python main.py
```

This will start up the fh-frankenui documentation site, which is a FastHTML app.
Expand Down

0 comments on commit 12f0662

Please sign in to comment.