Skip to content

Commit 10dff18

Browse files
committed
Tweak README
1 parent a5779b3 commit 10dff18

File tree

1 file changed

+2
-3
lines changed

1 file changed

+2
-3
lines changed

README.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -58,10 +58,9 @@ build specific pages (file `index_data/x.json` not found).
5858
- `data`: Contains hand-curated data, such as sidebar ordering, blog data, etc
5959
- `index_data`: Contains generated data, usually generated by scripts like `scripts/extract-tocs.js`
6060
- `compilers`: Contains a subdirectory with independently installed ReScript compilers, to be able to compile / test examples with different ReScript versions
61-
- `pages`: All Next pages. Those are written in JS / MDX, some pages are re-exporting ReScript based pages from `src/MyPage.res`
61+
- `pages`: All Next pages. Those are written in JS / MDX, some pages are re-exporting ReScript based pages from the `src/` directory.
6262
- `styles`: Contains all extra CSS that cannot be expressed with Tailwind
63-
- `src`: Contains all ReScript related code for the UI
64-
- `/`: Within `src`, you will find all ReScript based Next pages that are re-exported in the `pages` directory
63+
- `src`: Contains all ReScript related code for the UI. Within `src`, you will also find all ReScript based Next pages that are re-exported in the `pages` directory
6564
- `/bindings`: (Zero-cost) bindings to JS libraries / apis
6665
- `/common`: ReScript modules that are neither `bindings`, nor `components`
6766
- `/components`: ReScript / React components used by multiple pages

0 commit comments

Comments
 (0)