Change layout architecture

.gitignore

@@ -10,9 +10,6 @@ public/blog/feed.xml
 node_modules/
 .next/
 index_data/*.json
-!index_data/blog_authors.json
-!index_data/blog_posts.json
-!index_data/build-schema.json
 
 yarn-error.log
 

README.md

@@ -55,6 +55,9 @@ build specific pages (file `index_data/x.json` not found).
 
 ## Project Structure Overview
 
+- `data`: Contains hand-curated data, such as sidebar ordering, blog data, etc
+- `index_data`: Contains generated data, usually generated by scripts like `scripts/extract-tocs.js`
+- `compilers`: Contains a subdirectory with independently installed ReScript compilers, to be able to compile / test examples with different ReScript versions
 - `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
@@ -145,7 +148,7 @@ posts](https://rescript-lang.org/blogpost-guide).
 **Quick-takeaways:**
 
 - Blogposts are located in `_blogposts`
-- Author metadata is located in `index_data/blog_authors.json`
+- Author metadata is located in `data/blog_authors.json`
 - Make sure to follow the file naming rules
 
 ### Contributing

data/sidebar_community.json

@@ -0,0 +1,6 @@
+{
+  "Resources": [
+    "overview",
+    "code-of-conduct"
+  ]
+}

data/sidebar_gentype_latest.json

@@ -0,0 +1,10 @@
+{
+  "Overview": [
+    "introduction",
+    "getting-started",
+    "usage"
+  ],
+  "Advanced": [
+    "supported-types"
+  ]
+}

data/sidebar_manual_latest.json

@@ -0,0 +1,66 @@
+{
+  "Overview": [
+    "introduction",
+    "installation",
+    "editor-plugins",
+    "migrate-from-bucklescript-reason",
+    "try"
+  ],
+  "Language Features": [
+    "overview",
+    "let-binding",
+    "type",
+    "primitive-types",
+    "tuple",
+    "record",
+    "object",
+    "variant",
+    "null-undefined-option",
+    "array-and-list",
+    "function",
+    "control-flow",
+    "pipe",
+    "pattern-matching-destructuring",
+    "mutation",
+    "jsx",
+    "exception",
+    "lazy-values",
+    "promise",
+    "module",
+    "import-export",
+    "attribute",
+    "unboxed",
+    "reserved-keywords"
+  ],
+  "JavaScript Interop": [
+    "embed-raw-javascript",
+    "shared-data-types",
+    "external",
+    "bind-to-js-object",
+    "bind-to-js-function",
+    "import-from-export-to-js",
+    "bind-to-global-js-values",
+    "json",
+    "inlining-constants",
+    "use-illegal-identifier-names",
+    "generate-converters-accessors",
+    "browser-support-polyfills",
+    "interop-cheatsheet"
+  ],
+  "Build System": [
+    "build-overview",
+    "build-configuration",
+    "build-configuration-schema",
+    "interop-with-js-build-systems",
+    "build-performance"
+  ],
+  "Guides": [
+    "converting-from-js",
+    "libraries"
+  ],
+  "Extra": [
+    "newcomer-examples",
+    "project-structure",
+    "faq"
+  ]
+}

data/sidebar_manual_v800.json

@@ -0,0 +1,62 @@
+{
+  "Overview": [
+    "introduction",
+    "installation",
+    "editor-plugins",
+    "migrate-from-bucklescript-reason",
+    "try"
+  ],
+  "Language Features": [
+    "overview",
+    "let-binding",
+    "type",
+    "primitive-types",
+    "tuple",
+    "record",
+    "object",
+    "variant",
+    "null-undefined-option",
+    "array-and-list",
+    "function",
+    "control-flow",
+    "pipe",
+    "pattern-matching-destructuring",
+    "mutation",
+    "jsx",
+    "exception",
+    "lazy-values",
+    "promise",
+    "module",
+    "import-export",
+    "reserved-keywords"
+  ],
+  "JavaScript Interop": [
+    "embed-raw-javascript",
+    "shared-data-types",
+    "external",
+    "bind-to-js-object",
+    "bind-to-js-function",
+    "import-from-export-to-js",
+    "bind-to-global-js-values",
+    "json",
+    "use-illegal-identifier-names",
+    "generate-converters-accessors",
+    "browser-support-polyfills",
+    "interop-cheatsheet"
+  ],
+  "Build System": [
+    "build-overview",
+    "build-configuration",
+    "interop-with-js-build-systems",
+    "build-performance"
+  ],
+  "Guides": [
+    "converting-from-js",
+    "libraries"
+  ],
+  "Extra": [
+    "newcomer-examples",
+    "project-structure",
+    "faq"
+  ]
+}

next.config.js

@@ -28,7 +28,16 @@ const config = {
       }
     }
     return config
-  }
+  },
+  async redirects() {
+    return [
+      {
+        source: '/community',
+        destination: '/community/overview',
+        permanent: true,
+      },
+    ]
+  },
 };
 
 module.exports = withMdx(withTM(withCSS(config)));

pages/_app.js

@@ -7,6 +7,8 @@
 //}
 
 import "styles/main.css";
-import {make as App} from "src/common/App.js";
+import {make as ResApp} from "src/common/App.js";
 
-export default App;
+export default function App(props) {
+  return <ResApp {...props} />
+};

pages/blogpost-guide.mdx

@@ -28,7 +28,7 @@ touch _blogposts/2020-01-30-my-new-blog-post.mdx
 
 ### Map the file to a URL
 
-Open the `index_data/blog_posts.json` file and add a new mapping like this:
+Open the `data/blog_posts.json` file and add a new mapping like this:
 
 ```
 {
@@ -38,7 +38,7 @@ Open the `index_data/blog_posts.json` file and add a new mapping like this:
 
 The key describes the final slug (e.g. `/blog/my-new-blog-post`), while the value defines the relative filepath within the `_blogposts` directory.
 
-Save your changes within `index_data/blog_posts.json` and refresh your browser within [/blog](/blog).
+Save your changes within `data/blog_posts.json` and refresh your browser within [/blog](/blog).
 You should now see a warning for some malformed frontmatter data. Let's fix this!
 
 ## Add Frontmatter Data
@@ -72,7 +72,7 @@ canonical: https://rescript-lang.org/blog/2017/10/01/announcing-1-0
 ---
 ```
 
-- `author`: An author alias as defined in `./index_data/blog_authors.json`
+- `author`: An author alias as defined in `./data/blog_authors.json`
 - `co-authors`: A list of co-author aliases (same aliases allowed as in the `author` field)
 - `date`: A **string** date (always make sure to use the `"`, otherwise yaml
   will parse it as a `date`). The date format is `"YYYY-MM-DD hh:mm"`. All blog

pages/community/code-of-conduct.mdx

@@ -1,3 +1,9 @@
+---
+title: "Code of Conduct"
+description: "Our working codex for the ReScript community"
+canonical: "/community/code-of-conduct"
+---
+
 # Code of Conduct
 
 ## Our Pledge

pages/community.mdx → pages/community/overview.mdx

@@ -1,3 +1,9 @@
+---
+title: "Overview"
+description: "Community Resources Overview"
+canonical: "/community/overview"
+---
+
 # Community
 
 ## Core Team

pages/docs/gentype/latest/getting-started.mdx

@@ -1,3 +1,9 @@
+---
+title: "Getting Started"
+description: "How to get started with genType in your ReScript projects"
+canonical: "/docs/gentype/latest/getting-started"
+---
+
 # Getting Started
 
 `genType` is tightly integrated in the ReScript Compiler. It only requires minimal setup.

pages/docs/gentype/latest/introduction.mdx

@@ -1,3 +1,9 @@
+---
+title: "Introduction"
+description: "GenType - Interoperability between ReScript and TypeScript / Flow"
+canonical: "/docs/gentype/latest/introduction"
+---
+
 # GenType
 
 `genType` is a code generation tool that lets you export ReScript values and types to use in JavaScript, and import JavaScript values and types into ReScript.

pages/docs/gentype/latest/supported-types.mdx

@@ -1,3 +1,9 @@
+---
+title: "Supported Types"
+description: "Supported types and value convertion in GenType"
+canonical: "/docs/gentype/latest/supported-types"
+---
+
 # Supported Types
 
 <Intro>

pages/docs/manual/latest/build-configuration-schema.mdx

@@ -0,0 +1,19 @@
+---
+title: "Configuration Schema"
+metaTitle: "Build System Configuration Schema"
+description: "Schema exploration widget for the ReScript configuration file"
+canonical: "/docs/manual/latest/build-configuration-schema"
+---
+
+import dynamic from "next/dynamic";
+
+export const Docson = dynamic(() => import("src/components/Docson").then((comp) => {
+  return comp.make;
+}), {
+  ssr: false,
+  loading: () => <div> Loading... </div>
+});
+
+export default function BuildConfigurationSchemaPage() {
+  return <Docson/>;
+}

pages/docs/manual/latest/build-configuration.mdx

@@ -1,5 +1,6 @@
 ---
-title: "Build System Configuration"
+title: "Configuration"
+metaTitle: "Build System Configuration"
 description: "Details about the configuration of the ReScript build system (bsconfig.json)"
 canonical: "/docs/manual/latest/build-configuration"
 ---

pages/docs/manual/latest/build-overview.mdx

@@ -1,5 +1,6 @@
 ---
-title: "Build System Overview"
+title: "Overview"
+metaTitle: "Build System Overview"
 description: "Documentation about the ReScript build system and its toolchain"
 canonical: "/docs/manual/latest/build-overview"
 ---

pages/docs/manual/latest/build-performance.mdx

@@ -1,5 +1,6 @@
 ---
-title: "Build Performance"
+title: "Performance"
+metaTitle: "Build Performance"
 description: "ReScript build performance and measuring tools"
 canonical: "/docs/manual/latest/build-performance"
 ---

pages/docs/manual/latest/introduction.mdx

@@ -1,5 +1,5 @@
 ---
-title: "ReScript Introduction"
+title: "Introduction"
 description: "The hows and whys of ReScript"
 canonical: "/docs/manual/latest/introduction"
 ---

pages/docs/manual/latest/overview.mdx

@@ -1,5 +1,6 @@
 ---
-title: "Language Features Overview"
+title: "Overview"
+metaTitle: "Language Features Overview"
 description: "A quick overview on ReScript's syntax"
 canonical: "/docs/manual/latest/overview"
 ---

pages/docs/manual/latest/promise.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Promise"
+title: "Async & Promise"
 description: "JS Promise handling in ReScript"
 canonical: "/docs/manual/latest/promise"
 ---

pages/docs/manual/latest/unboxed.mdx

@@ -4,6 +4,8 @@ description: "Unbox a wrapper"
 canonical: "/docs/manual/latest/unboxed"
 ---
 
+# Unboxed
+
 Consider a ReScript variant with a single payload, and a record with a single field:
 
 <CodeTab labels={["ReScript", "JS Output"]}>

pages/docs/manual/v8.0.0/introduction.mdx

@@ -1,5 +1,5 @@
 ---
-title: "ReScript Introduction"
+title: "Introduction"
 description: "The hows and whys of ReScript"
 canonical: "/docs/manual/latest/introduction"
 ---

pages/docs/manual/v8.0.0/overview.mdx

@@ -1,5 +1,6 @@
 ---
-title: "Language Features Overview"
+title: "Overview"
+metaTitle: "Language Features Overview"
 description: "A quick overview on ReScript's syntax"
 canonical: "/docs/manual/latest/overview"
 ---