Docs updates #272

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

davenquinn merged 3 commits into main from docs-updates

May 17, 2025

content/.obsidian/core-plugins.json

-Original file line number
+Diff line change
@@ -1,20 +1,31 @@
-    [
-      "file-explorer",
-      "global-search",
-      "switcher",
-      "graph",
-      "backlink",
-      "canvas",
-      "outgoing-link",
-      "tag-pane",
-      "page-preview",
-      "daily-notes",
-      "templates",
-      "note-composer",
-      "command-palette",
-      "editor-status",
-      "bookmarks",
-      "outline",
-      "word-count",
-      "file-recovery"
-    ]
+    {
+      "file-explorer": true,
+      "global-search": true,
+      "switcher": true,
+      "graph": true,
+      "backlink": true,
+      "canvas": true,
+      "outgoing-link": true,
+      "tag-pane": true,
+      "properties": false,
+      "page-preview": true,
+      "daily-notes": true,
+      "templates": true,
+      "note-composer": true,
+      "command-palette": true,
+      "slash-command": false,
+      "editor-status": true,
+      "bookmarks": true,
+      "markdown-importer": false,
+      "zk-prefixer": false,
+      "random-note": false,
+      "outline": true,
+      "word-count": true,
+      "slides": false,
+      "audio-recorder": false,
+      "workspaces": false,
+      "file-recovery": true,
+      "publish": false,
+      "sync": false,
+      "webviewer": false
+    }

content/Architecture.md

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -1,7 +1,7 @@
  
    - Macrostrat is centered around a [[PostgreSQL]] database

    		- A "database-centric" application

        - A "database-centric" application

    ## Architectural models

    - Supabase

    - [[PostgREST]]
      
    - [PostgREST](https://postgrest.org/)

content/Community.md

-Original file line number
+Diff line change
@@ Expand Up / @@ -2,7 +2,9 @@ Macrostrat is part of a broad geoinformatics ecosystem. @@
     ## Geological systems
-    - The [EarthByte](https://www.earthbyte.org) group is engaged in many complementary activities towards building a digital crust
+    - Paleobiology database (PBDB): [https://paleobiodb.org](https://paleobiodb.org)
+    - The [EarthByte](https://www.earthbyte.org) group is engaged in many complementary activities towards building a
+      digital crust
     ## Cool Earth observing websites
@@ Expand Down @@

content/Components/Macrostrat data services.md

-Original file line number
+Diff line change
@@ Expand Up / @@ -3,12 +3,16 @@ geologic column data. @@
     There are two main reasons for this:
-. Macrostrat currently contains voluminous geologic map and column data that cannot be accessed in aggregate anywhere else.
-    	- Over 300 different geologic maps, containing more than 2.5 million rock unit polygons covering the world, have been integrated into a single, unified, queryable environment in Macrostrat.
-    	- Additionally, more than 35,000 rock units from over 1,500 regional columns covering all of North America and limited other regions are publicly available.
-. Macrostrat has a public "REST" application programming interface (API) that makes the full complement of data available in Findable, Accessible, Interoperable, and Reusable (FAIR) fashion with a CC-BY license.
+. Macrostrat currently contains voluminous geologic map and column data that cannot be accessed in aggregate anywhere
+       else.
+        - Over 300 different geologic maps, containing more than 2.5 million rock unit polygons covering the world, have
+          been integrated into a single, unified, queryable environment in Macrostrat.
+        - Additionally, more than 35,000 rock units from over 1,500 regional columns covering all of North America and
+          limited other regions are publicly available.
+. Macrostrat has a public "REST" application programming interface (API) that makes the full complement of data
+       available in Findable, Accessible, Interoperable, and Reusable (FAIR) fashion with a CC-BY license.
-    Many third-party applications and users take advantage of Macrostrat FAIR data services:
+    Many third-party applications and users take advantage of Macrostrat data services:
     - Mancos
     - StraboSpot
@@ Expand All @@
     ## Usage
     Macrostrat’s data services have become impactful community resources for geologic information:
     - Our geologic map server has served more than 2 billion tile requests since logging began in 2018 (~10 per second)
     - Over the last 28 days, our other data APIs have served 3.8 million requests (~2 per second).
-    - Conservatively, these amount to 100,000 requests for information each day.
+    - Conservatively, these amount to 100,000 requests for information each day.

content/Macrostrat.md

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -1,10 +1,11 @@
  
    ---

    permalink: index

    title: Documentation

    ---

    Macrostrat is a geological model of the Earth's crust and its stratigraphic

    framework. It is a community-driven project that is centered at the University

    of Wisconsin–Madison.

    framework. It is currently developed at the eponymous lab at University of Wisconsin–Madison, by a team of geologists

    and software engineers.

    The Macrostrat data platform underlies [Rockd](https://rockd.org/), a mobile

    application that allows users to explore the geology of the world around them.

    @@ -18,3 +19,9 @@ more fully to contributors in [[Version 2]].
  
    The documentation is open-source, and we encourage contributions. Please

    contribute on [GitHub](https://github.com/UW-Macrostrat/docs).

    ## Sections

    - [Legacy documentation](/docs/legacy)

    - [Web components](/docs/web-components)

    - [Python](/docs/python-libraries)

content/Version 2.md

-Original file line number
+Diff line change
@@ -1,6 +1,5 @@
     - A vision to create a new version of Macrostrat with a community-contribution model.
     - Macrostrat v1 effectively harnessed geologic data, but Macrostrat v2 seeks to harness the community
     - Vision first described in a GSA talk in 2021
-    - Elaborated in this paper
-    The first round of funding to support initial development along these lines was secured in summer 2022 by [[Daven Quinn]]
+    The first round of funding to support initial development along these lines was secured in summer 2023 by [[Daven Quinn]]

pages/+Page.mdx

-Original file line number
+Diff line change
@@ Expand Up @@
       Layers and testbed apps that aren't ready for prime time
     </LinkCard>
-    <LinkCard href="/docs/" title="Documentation">
+    <LinkCard href="/docs" title="Documentation">
       Macrostrat documentation
     </LinkCard>

pages/+config.ts

-Original file line number
+Diff line change
@@ Expand Up / @@ -26,6 +26,7 @@ export default { @@
       ],
       clientRouting: true,
       supportsDarkMode: true,
+      trailingSlash: false,
       meta: {
         supportsDarkMode: {
           env: {
@@ Expand Down @@

0 pages/dev/docs/+Page.ts → pages/docs/catch-all/+Page.ts

File renamed without changes.

pages/dev/docs/+config.ts → pages/docs/catch-all/+config.ts

-Original file line number
+Diff line change
@@ Expand Up / @@ -10,5 +10,5 @@ export default { @@
         "mdxContent",
         "title",
       ],
-      route: "/dev/docs*",
+      route: "/docs*",
     } satisfies Config;

pages/dev/docs/+onBeforeRender.ts → pages/docs/catch-all/+onBeforeRender.ts

-Original file line number
+Diff line change
@@ Expand Up @@
     import { renderToString } from "react-dom/server";
     import { PageContext } from "vike/types";
     import h from "@macrostrat/hyper";
     const modules = import.meta.glob("../../../content/**/*.md");
     import { join } from "path";
     import { dirname } from "path";
@@ Expand All / @@ -12,7 +13,7 @@ const __dirname = dirname(fileURLToPath(import.meta.url)); @@
     const contentDirName = "../../../content";
     const contentDir = join(__dirname, contentDirName);
-    const [pageIndex, permalinkIndex] = buildPageIndex(contentDir, "/dev/docs");
+    const [pageIndex, permalinkIndex] = buildPageIndex(contentDir, "/docs");
     type OurPageContext = {
       mdxContent: string | null;
@@ Expand Down Expand Up / @@ -64,5 +65,3 @@ export async function onBeforeRender( @@
         },
       };
     }
-    export const passToClient = ["mdxContentFile", "mdxContent", "title"];

pages/docs/catch-all/route.ts

-Original file line number
+Diff line change
@@ -0,0 +1,10 @@
+    // product/catch-all/+route.js
+    export default (pageContext) => {
+      if (!pageContext.urlPathname.startsWith("/docs")) return false;
+      return {
+        precedence: -1,
+        pageContext: {
+          redirectTo: "/docs",
+        },
+      };
+    };

pages/docs/images/IngestionProcess.png

Binary file not shown.

0 pages/docs/+Page.mdx → pages/docs/legacy/+Page.mdx

File renamed without changes.

0 pages/docs/api/postgrest/+Page.ts → pages/docs/legacy/api/postgrest/+Page.ts

File renamed without changes.

0 pages/docs/api/postgrest/+onBeforeRender.ts → ...s/legacy/api/postgrest/+onBeforeRender.ts

File renamed without changes.

0 pages/docs/ingestion/+Page.mdx → pages/docs/legacy/ingestion/+Page.mdx

File renamed without changes.

0 pages/docs/ingestion/harmonization/+Page.mdx → .../legacy/ingestion/harmonization/+Page.mdx

File renamed without changes.

0 pages/docs/ingestion/integration/+Page.mdx → ...cs/legacy/ingestion/integration/+Page.mdx

File renamed without changes.

0 pages/docs/integrations/qgis/+Page.mdx → ...s/docs/legacy/integrations/qgis/+Page.mdx

File renamed without changes.

src/components/navigation/PageBreadcrumbs.ts

-Original file line number
+Diff line change
@@ Expand Up / @@ -7,6 +7,7 @@ import h from "./breadcrumbs.module.sass"; @@
     export function PageBreadcrumbs({ showLogo = false, title }) {
       const ctx = usePageContext();
       const items = useMemo(() => {
         let items = buildBreadcrumbs(ctx.urlPathname, sitemap, ctx);
         if (title != null) {
@@ Expand Down @@

vite.config.ts

-Original file line number
+Diff line change
@@ Expand Up / @@ -86,9 +86,10 @@ export default defineConfig({ @@
         cjsInterop({
           dependencies: ["react-images", "labella", "react-color", "mapbox-gl"],
         }),
+        // This should maybe be integrated directly into the server-side rendering code
         textToolchain({
           contentDir: path.resolve(__dirname, "content"),
-          wikiPrefix: "/dev/docs",
+          wikiPrefix: "/docs",
         }),
         /* Fix error with single-page app reloading where paths
         with dots (e.g., locations) are not rewritten to index
@@ Expand Down @@

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Docs updates #272

Uh oh!

Diff view

Diff view

There are no files selected for viewing