Merge pull request #147 from reason-association/project-cleanup

Project cleanup

Author: ryyppy

README.md

@@ -53,6 +53,20 @@ All the index data is stored in `index_data`, but will not be tracked by git.
 Make sure to build the index after a fresh clone, otherwise Next might not
 build specific pages (file `index_data/x.json` not found).
 
+## Project Structure Overview
+
+- `pages`: All Next pages. Those are written in JS / MDX, some pages are re-exporting ReScript based pages from `src/MyPage.res`
+- `styles`: Contains all extra CSS that cannot be expressed with Tailwind
+- `src`: Contains all ReScript related code for the UI
+  - `/`: Within `src`, you will find all ReScript based Next pages that are re-exported in the `pages` directory
+  - `/bindings`: (Zero-cost) bindings to JS libraries / apis
+  - `/common`: ReScript modules that are neither `bindings`, nor `components`
+  - `/components`: ReScript / React components used by multiple pages
+  - `/ffi`: (to be deprecated) Plain JS that some ReScript code binds to (use `raw` statements for that)
+  - `/layouts`: All Next layouts used in our pages. Check out `src/common/App.res` for mapping layouts to routes
+- `scripts`: Contains a mix of JS / ReScript based scripts that do all kind of code generation / code introspection logic
+- `tailwind.config.js`: Contains our Tailwind configuration for all the low level design tokens
+
 ## Run Tests
 
 ### Markdown Codeblock Tests

_blogposts/2020-08-28-new-rescript-logo.mdx

@@ -8,7 +8,7 @@ description: |
   Today, our resident designer Bettina is unveiling to us the fresh new ReScript branding we've been long waiting for. We hope you're as excited about the result as us!
 ---
 
-import Image from "components/Image";
+import Image from "src/components/Image";
 
 ## Why the Rebranding?
 

_blogposts/2020-11-17-editor-support-custom-operators-and-more.mdx

@@ -10,7 +10,7 @@ description: |
 canonical: https://rescript-lang.org/blog/rescript-the-road-ahead
 ---
 
-import Video from "components/Video"
+import Video from "src/components/Video"
 
 ## Upcoming Improvements
 

_blogposts/archive/state-of-reasonml-org-2020-q2-pt1.mdx

@@ -10,7 +10,7 @@ description: |
   to expect in the future. The first part is an introduction to our project.
 ---
 
-import Image from "components/Image";
+import Image from "src/components/Image";
 
 ## Hello World!
 

_blogposts/archive/state-of-reasonml-org-2020-q2-pt3.mdx

@@ -9,7 +9,7 @@ description: |
   talk about upcoming tools and features. 
 ---
 
-import Image from "components/Image";
+import Image from "src/components/Image";
 
 ## Future Tools for the Community
 

_blogposts/archive/state-of-reasonml-org-2020-q2-pt4.mdx

@@ -10,7 +10,7 @@ description: |
   This is the final part of the series about our vision of a more accessible Reason platform.
 ---
 
-import Image from "components/Image";
+import Image from "src/components/Image";
 
 ## It's all Opinions
 

bindings/IntlDateTimeFormat.js

@@ -15,29 +15,14 @@
   "ppx-flags": [],
   "sources": [
     {
-      "dir": "common"
-    },
-    {
-      "dir": "bindings"
-    },
-    {
-      "dir": "pages",
-      "subdirs": true
-    },
-    {
-      "dir": "re_pages",
+      "dir": "src",
       "subdirs": true
     },
     {
       "dir": "scripts",
       "subdirs": true,
       "type": "dev"
-    },
-    {
-      "dir": "components",
-      "subdirs": true
-    },
-    "layouts"
+    }
   ],
   "package-specs": {
     "module": "es6",