Skip to content

Commit 826d70b

Browse files
authored
docs: Update frontend dev docs (#2666)
Resolves #2633 ## Changes - Replaces broken link in frontend README with hosted and local links - Clarifies that frontend is not deployed separately in dev docs
1 parent 1a6d2a2 commit 826d70b

File tree

2 files changed

+21
-4
lines changed

2 files changed

+21
-4
lines changed

frontend/README.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,19 @@
1-
[Development guide](../docs/develop/frontend-dev.md)
1+
# Browsertrix Frontend
2+
3+
This directory contains the following components:
4+
5+
## Docs (`/docs`)
6+
7+
Documentation for running, developing, and writing docs:
8+
- Hosted: [docs.browsertrix.com/develop/docs](https://docs.browsertrix.com/develop/docs)
9+
- Local: [develop/docs.md](./docs/docs/develop/docs.md)
10+
11+
## User Interface (`/src`)
12+
13+
Documentation for developing the user interface:
14+
- Hosted: [docs.browsertrix.com/develop/frontend-dev](https://docs.browsertrix.com/develop/frontend-dev)
15+
- Local: [develop/frontend-dev.md](./docs/docs/develop/frontend-dev.md)
16+
17+
## Configuration
18+
19+
Config files for the frontend Docker build and nginx routing can also be found in this directory.

frontend/docs/docs/develop/local-dev-setup.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -130,6 +130,5 @@ After making any changes to backend code (in `./backend`) or frontend code (in `
130130

131131
Changes to settings in `./chart/local.yaml` can be deployed with `helm upgrade ...` directly.
132132

133-
## Deploying Frontend Only
134-
135-
If you are just making changes to the frontend, you can also [deploy the frontend separately](frontend-dev.md) using a dev server for quicker iteration.
133+
??? Info "Alternative method for developing the frontend"
134+
If you are not writing backend code or otherwise making changes to the backend, you can run the frontend outside of Docker to quickly iterate on the user interface. See [UI Development](./frontend-dev.md) for instructions on how to develop the frontend using Node.js tools.

0 commit comments

Comments
 (0)