Skip to content

Commit

Permalink
update
Browse files Browse the repository at this point in the history
  • Loading branch information
dwreeves committed Nov 20, 2024
1 parent 62054bd commit 2685497
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 9 deletions.
6 changes: 3 additions & 3 deletions docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,14 +31,14 @@ Add this where you want the iFrame to be:

## For Developers

To locally deploy the website and start coding, follow the [setup guide](../setup).
To locally deploy the website and start coding, follow the [setup guide](./setup).

Once you have the website setup locally, you now have access to the following:

- Deploy the website to Heroku (guide [here](../deployment))
- Deploy the website to Heroku (guide [here](./deployment))
- Manually run commands and download data through the `flask shell`.
- Make changes to the predictive model, including revising its coefficients. (Guide is currently WIP)
- (Advanced) Make other changes to the website.
- Make other changes to the website.

## To Deploy

Expand Down
2 changes: 1 addition & 1 deletion docs/src/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ After you get everything set up, you should run the website at least once.
To do this, run the following:

=== "Windows (CMD)"
```shell
```cmd
uv venv .venv
.\.venv\Scripts\activate.bat
uv pip sync requirements.txt
Expand Down
8 changes: 3 additions & 5 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -45,9 +45,9 @@ markdown_extensions:
- pymdownx.inlinehilite
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: "!!python/name:pymdownx.superfences.fence_div_format"
- name: mermaid
class: mermaid
format: "!!python/name:pymdownx.superfences.fence_code_format"
- sane_lists
extra:
flagging_website_url: https://crwa-flagging.herokuapp.com
Expand All @@ -58,5 +58,3 @@ extra:
link: https://www.meetup.com/Code-for-Boston/
- icon: fontawesome/brands/twitter
link: https://twitter.com/codeforboston
extra_javascript:
- https://unpkg.com/[email protected]/dist/mermaid.min.js

0 comments on commit 2685497

Please sign in to comment.