Prototype for new stdlib hierarchy

tweag · Apr 12, 2023 · b08fe67 · b08fe67
1 parent 6c672af
commit b08fe67
Show file tree

Hide file tree

Showing 4 changed files with 52 additions and 25 deletions.
diff --git a/flake.lock b/flake.lock
diff --git a/gatsby-node.js b/gatsby-node.js
@@ -60,10 +60,10 @@ exports.createPages = async ({ actions, graphql, reporter }) => {
     redirectToIntro("/user-manual/");
     redirectToIntro("/user-manual");
 
-    let redirectToStdlibArray = fromPath => (
+    let redirectToStdlibStd = fromPath => (
         actions.createRedirect({
             fromPath,
-            toPath: `/stdlib/array`,
+            toPath: `/stdlib/std`,
             redirectInBrowser: true,
             isPermanent: true,
         })
@@ -73,7 +73,23 @@ exports.createPages = async ({ actions, graphql, reporter }) => {
     redirectToStdlibArray("/stdlib");
 };
 
-exports.onCreateNode = ({ node, getNode, createNodeId, actions }) => {
+const makeStdlibSection = ({ actions, createNodeId, createContentDigest, node, slug, name, content }) => {
+    newNode = {
+        id: createNodeId(`${node.id} >>> Nickel Stdlib Doc ${slug}`),
+        parent: node.id,
+        slug,
+        name,
+        internal: {
+            contentDigest: createContentDigest(content),
+            content: JSON.stringify(content),
+            type: "StdlibSection"
+        }
+    };
+    actions.createNode(newNode);
+    actions.createParentChildLink({ parent: node, child: newNode })
+}
+
+exports.onCreateNode = ({ node, getNode, createNodeId, createContentDigest, actions }) => {
     if (node.internal.type === "MarkdownRemark" && getNode(node.parent).sourceInstanceName === "user-manual") {
         newNode = {
             id: createNodeId(`Nickel User Manual ${node.id}`),
@@ -89,19 +105,27 @@ exports.onCreateNode = ({ node, getNode, createNodeId, actions }) => {
     }
 
     if (node.internal.type === "NickelStdlibDocJson") {
-        const slug = getNode(node.parent).name;
+        const toplevelName = getNode(node.parent).name;
+        docsContent = JSON.parse(getNode(node.parent).internal.content);
 
-        newNode = {
-            id: createNodeId(`Nickel Stdlib Doc ${node.id}`),
-            parent: node.id,
-            slug,
-            internal: {
-                contentDigest: node.internal.contentDigest,
-                content: getNode(node.parent).internal.content,
-                type: "StdlibSection"
-            }
-        }
-        actions.createNode(newNode);
-        actions.createParentChildLink({ parent: node, child: newNode })
+        toplevelFields = Object.fromEntries(Object.entries(docsContent).filter(([key, value]) => !value.fields));
+
+        makeStdlibSection({
+            actions, createNodeId, createContentDigest,
+            node,
+            slug: toplevelName,
+            name: toplevelName,
+            content: toplevelFields,
+        })
+
+        Object.entries(docsContent).filter(([key, value]) => !!value.fields).forEach(([slug, value]) => {
+            makeStdlibSection({
+                actions, createNodeId, createContentDigest,
+                node,
+                slug: `${toplevelName}-${slug}`,
+                name: `${toplevelName}.${slug}`,
+                content: value.fields,
+            })
+        });
     }
 }
diff --git a/src/components/stdlib-toc.js b/src/components/stdlib-toc.js
@@ -40,6 +40,7 @@ export default function SidebarToc({active, headings}) {
                     edges {
                         node {
                             slug
+                            name
                         }
                     }
                   }
@@ -53,11 +54,11 @@ export default function SidebarToc({active, headings}) {
                         </div>
 
                         <ul>
-                            {data.allStdlibSection.edges.map(({node: { slug }}) => {
+                            {data.allStdlibSection.edges.map(({node: { slug, name }}) => {
                                 const key = `sec-stdlib-${slug}`;
                                 return (
                                     <li key={key}>
-                                        <Link className="link-primary" activeClassName="sidebar-link-active" to={`${data.site.siteMetadata.stdlib.link}/${slug}`}>{slug}</Link>
+                                        <Link className="link-primary" activeClassName="sidebar-link-active" to={`${data.site.siteMetadata.stdlib.link}/${slug}`}>{name}</Link>
                                         {
                                             (slug === active) ?
                                                 subMenu({

diff --git a/src/pages/stdlib/{StdlibSection.slug}.js b/src/pages/stdlib/{StdlibSection.slug}.js
@@ -13,9 +13,10 @@ import ReactMarkdown from 'react-markdown';
 const Stdlib = ({data}) => {
     const object = JSON.parse(data.stdlibSection.internal.content);
     const slug = data.stdlibSection.slug; 
+    const name = data.stdlibSection.name; 
     const sidebarProps = {
         active: slug,
-        headings: object[slug].fields,
+        headings: object,
     };
 
     const HeaderWithTypes = ({id, name, types, contracts}) => {
@@ -84,7 +85,6 @@ const Stdlib = ({data}) => {
         })
     };
 
-  console.log(object[`${slug}`].fields);
   return (
       <Layout>
         <div className="container-fluid">
@@ -95,20 +95,22 @@ const Stdlib = ({data}) => {
                 </div>
                 <div className={"col-xl-9 col-lg-8 col-md-7 order-2"}>
                     <div className={"container content-main-container content documentation-page"}>
-                        <h2>{slug.charAt(0).toUpperCase() + slug.slice(1)}</h2>
-                        <DocEntries prefix={``} fields={object[`${slug}`].fields} />
+                        <h2>{name}</h2>
+                        <DocEntries prefix={``} fields={object} />
                     </div>
                 </div>
             </div>
         </div>
       </Layout>
   )
+                        // <h2>{name.charAt(0).toUpperCase() + name.slice(1)}</h2>
 };
 
 export const pageQuery = graphql`
   query($id: String) {
     stdlibSection(id: { eq: $id }) {
         slug
+        name
         internal { content }
     }
   }