Skip to content

Commit b77c87e

Browse files
committed
Update documentation.
* Clean up and create placeholders for future documentation.
1 parent 743e58f commit b77c87e

File tree

3 files changed

+47
-48
lines changed

3 files changed

+47
-48
lines changed

README.md

Lines changed: 38 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,65 +1,60 @@
1-
# Open Fresno Storybook (Next.js)
1+
# Open Fresno website documentation
22

3-
This repository hosts the **Storybook + Next.js testing environment** for Open Fresno. It provides a sandbox for building, documenting, and testing UI components in isolation before they are integrated into the main site. The main repository is https://github.com/openfresno/openfresno.org.
3+
This repository hosts the **Storybook + Next.js testing environment** for the Open Fresno website. It provides a sandbox
4+
for building, documenting, and testing UI components in isolation before they are integrated into the main site.
45

5-
## Get Started
6-
7-
### Prerequisites
8-
9-
- Node.js
10-
- PNPM
11-
12-
### Installation
6+
> [!NOTE]
7+
> The Open Fresno website repository
8+
> is [github.com/openfresno/openfresno.org](https://github.com/openfresno/openfresno.org).
139
14-
Clone the repo and install dependencies:
10+
> [!WARNING]
11+
> The code should be periodically kept up to date with the main repository by manually copy/pasting the `src/` folder.
1512
16-
```
17-
git clone https://github.com/openfresno/fe-openfresno-doc
18-
cd fe-openfresno-doc
19-
pnpm i
20-
```
13+
## Prerequisites
2114

22-
### Running Storybook
15+
- PNPM. Get help installing
16+
PNPM [here](https://openfresno.github.io/fe-openfresno.org-doc/?path=/docs/developer-guide--docs#install-pnpm)
17+
or https://pnpm.io/installation.
2318

24-
Start the Storybook development server:
19+
## Get Started
2520

26-
```
27-
pnpm run storybook
28-
```
21+
1. Install the Node.js dependencies.
2922

30-
Storybook will be available at **http://localhost:6006**.
23+
```
24+
pnpm i
25+
```
3126

32-
### Running Next.js
27+
2. Start the Storybook development server.
3328

34-
The regular website can be previewed as well.
29+
```
30+
pnpm storybook
31+
```
3532

36-
> [!NOTE]
37-
> The code should be periodically kept up to date with the main repository by manually copy/pasting the `src/` folder.
33+
3. (Optional) Preview the regular Next.js website.
3834

39-
```
40-
pnpm run dev
41-
```
35+
```
36+
pnpm dev
37+
```
4238

4339
## Testing
4440

45-
This repo is designed for component-driven development. We use:
41+
### Storybook
42+
43+
The public Storybook is deployed to GitHub Pages at https://openfresno.github.io/fe-openfresno.org-doc/. You can learn
44+
about the components and also run tests.
4645

47-
- **Storybook** for isolated UI development
48-
- **Vitest** for unit tests
49-
- **Playwright** for visual regression and interaction tests
46+
### Playwright
5047

51-
## Contribute
48+
Visual regression and interaction tests. These tests also contain critical tests that should be included in the main
49+
website repository for use in CI/CD pipelines.
5250

53-
We welcome contributions! Here are a few ways to help:
51+
### Vitest
5452

55-
1. Look for Issues tagged `help wanted` or `good first issue`.
56-
2. Add or improve component stories to increase coverage.
57-
3. Write tests for new components or edge cases.
58-
4. Submit a pull request with clear commit messages.
53+
Unit tests and coverage.
5954

6055
## Resources
6156

62-
- [Storybook Docs](https://storybook.js.org/docs/ "null")
63-
- [Next.js Docs](https://nextjs.org/docs "null")
64-
- [React Testing Library](https://testing-library.com/docs/react-testing-library/intro/ "null")
65-
- [Code of Conduct](https://www.google.com/search?q=https://github.com/openfresno/fe-openfresno-doc/blob/main/CODE_OF_CONDUCT.md "null")
57+
- [Contributing guide](https://github.com/openfresno/openfresno.org/blob/main/CONTRIBUTING.md)
58+
- [Open Fresno's Code of Conduct](https://www.google.com/search?q=https://github.com/openfresno/fe-openfresno-doc/blob/main/CODE_OF_CONDUCT.md)
59+
- [Storybook documentation](https://storybook.js.org/docs)
60+
- [Next.js documentation](https://nextjs.org/docs)
Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,20 @@
11
import { Meta } from "@storybook/addon-docs/blocks";
22

3-
<Meta title="File Structure" />
3+
<Meta title="Developer Guide" />
4+
5+
# Developer Guide
6+
7+
## Install PNPM
48

59
## 📂 Open Fresno website project structure
610

711
- public/ — Shared UI components
812
- src/app/ — Next.js pages (for integration testing)
913
- src/components/layout — Layout components (base layout, navbar, footer).
1014
- src/components/ui — Custom UI components.
11-
- src/components/index.js — All UI components are available through this index.js. Example: import \{ thing \} from "@/components/ui"
12-
- src/components/ui/icon — Custom-made icons (put third-party in integrations).
13-
- src/components/ui/timeline —
15+
- src/components/index.js — All UI components are available through this index.js. Example: import \{ thing \} from "@/components/ui"
16+
- src/components/ui/icon — Custom-made icons (put third-party in integrations).
17+
- src/components/ui/timeline —
1418
- src/integrations/ — Integration with external services
1519
- src/utility/ — Utility functions and helpers
1620
- styles/ — **DEPRECATED**: SCSS styles. Use src/app/-styles/main.css.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ export const RightArrow = () => (
2020
</svg>
2121
);
2222

23-
<Meta title="Style Guide Contributing" />
23+
<Meta title="Style Guide" />
2424

2525
<div className="sb-container">
2626
<div className="sb-section-title">

0 commit comments

Comments
 (0)