Skip to content

Commit 69f4a68

Browse files
authored
Merge pull request #272 from UW-Macrostrat/docs-updates
Docs updates
2 parents 5ad7ff4 + 1bf8ccf commit 69f4a68

File tree

22 files changed

+75
-39
lines changed

22 files changed

+75
-39
lines changed
Lines changed: 31 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,31 @@
1-
[
2-
"file-explorer",
3-
"global-search",
4-
"switcher",
5-
"graph",
6-
"backlink",
7-
"canvas",
8-
"outgoing-link",
9-
"tag-pane",
10-
"page-preview",
11-
"daily-notes",
12-
"templates",
13-
"note-composer",
14-
"command-palette",
15-
"editor-status",
16-
"bookmarks",
17-
"outline",
18-
"word-count",
19-
"file-recovery"
20-
]
1+
{
2+
"file-explorer": true,
3+
"global-search": true,
4+
"switcher": true,
5+
"graph": true,
6+
"backlink": true,
7+
"canvas": true,
8+
"outgoing-link": true,
9+
"tag-pane": true,
10+
"properties": false,
11+
"page-preview": true,
12+
"daily-notes": true,
13+
"templates": true,
14+
"note-composer": true,
15+
"command-palette": true,
16+
"slash-command": false,
17+
"editor-status": true,
18+
"bookmarks": true,
19+
"markdown-importer": false,
20+
"zk-prefixer": false,
21+
"random-note": false,
22+
"outline": true,
23+
"word-count": true,
24+
"slides": false,
25+
"audio-recorder": false,
26+
"workspaces": false,
27+
"file-recovery": true,
28+
"publish": false,
29+
"sync": false,
30+
"webviewer": false
31+
}

content/Architecture.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
- Macrostrat is centered around a [[PostgreSQL]] database
2-
- A "database-centric" application
2+
- A "database-centric" application
33

44
## Architectural models
55

66
- Supabase
7-
- [[PostgREST]]
7+
- [PostgREST](https://postgrest.org/)

content/Community.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@ Macrostrat is part of a broad geoinformatics ecosystem.
22

33
## Geological systems
44

5-
- The [EarthByte](https://www.earthbyte.org) group is engaged in many complementary activities towards building a digital crust
5+
- Paleobiology database (PBDB): [https://paleobiodb.org](https://paleobiodb.org)
6+
- The [EarthByte](https://www.earthbyte.org) group is engaged in many complementary activities towards building a
7+
digital crust
68

79
## Cool Earth observing websites
810

content/Components/Macrostrat data services.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,16 @@ geologic column data.
33

44
There are two main reasons for this:
55

6-
1. Macrostrat currently contains voluminous geologic map and column data that cannot be accessed in aggregate anywhere else.
7-
- 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.
8-
- 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.
9-
2. 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.
6+
1. Macrostrat currently contains voluminous geologic map and column data that cannot be accessed in aggregate anywhere
7+
else.
8+
- Over 300 different geologic maps, containing more than 2.5 million rock unit polygons covering the world, have
9+
been integrated into a single, unified, queryable environment in Macrostrat.
10+
- Additionally, more than 35,000 rock units from over 1,500 regional columns covering all of North America and
11+
limited other regions are publicly available.
12+
2. Macrostrat has a public "REST" application programming interface (API) that makes the full complement of data
13+
available in Findable, Accessible, Interoperable, and Reusable (FAIR) fashion with a CC-BY license.
1014

11-
Many third-party applications and users take advantage of Macrostrat FAIR data services:
15+
Many third-party applications and users take advantage of Macrostrat data services:
1216

1317
- Mancos
1418
- StraboSpot
@@ -21,6 +25,7 @@ Many third-party applications and users take advantage of Macrostrat FAIR data s
2125
## Usage
2226

2327
Macrostrat’s data services have become impactful community resources for geologic information:
28+
2429
- Our geologic map server has served more than 2 billion tile requests since logging began in 2018 (~10 per second)
2530
- Over the last 28 days, our other data APIs have served 3.8 million requests (~2 per second).
26-
- Conservatively, these amount to 100,000 requests for information each day.
31+
- Conservatively, these amount to 100,000 requests for information each day.

content/Macrostrat.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
---
22
permalink: index
3+
title: Documentation
34
---
45

56
Macrostrat is a geological model of the Earth's crust and its stratigraphic
6-
framework. It is a community-driven project that is centered at the University
7-
of Wisconsin–Madison.
7+
framework. It is currently developed at the eponymous lab at University of Wisconsin–Madison, by a team of geologists
8+
and software engineers.
89

910
The Macrostrat data platform underlies [Rockd](https://rockd.org/), a mobile
1011
application that allows users to explore the geology of the world around them.
@@ -18,3 +19,9 @@ more fully to contributors in [[Version 2]].
1819

1920
The documentation is open-source, and we encourage contributions. Please
2021
contribute on [GitHub](https://github.com/UW-Macrostrat/docs).
22+
23+
## Sections
24+
25+
- [Legacy documentation](/docs/legacy)
26+
- [Web components](/docs/web-components)
27+
- [Python](/docs/python-libraries)

content/Version 2.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
- A vision to create a new version of Macrostrat with a community-contribution model.
22
- Macrostrat v1 effectively harnessed geologic data, but Macrostrat v2 seeks to harness the community
33
- Vision first described in a GSA talk in 2021
4-
- Elaborated in this paper
54

6-
The first round of funding to support initial development along these lines was secured in summer 2022 by [[Daven Quinn]]
5+
The first round of funding to support initial development along these lines was secured in summer 2023 by [[Daven Quinn]]

pages/+Page.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,6 @@ These products come from a variety of sources throughout the geosciences.
3535
Layers and testbed apps that aren't ready for prime time
3636
</LinkCard>
3737

38-
<LinkCard href="/docs/" title="Documentation">
38+
<LinkCard href="/docs" title="Documentation">
3939
Macrostrat documentation
4040
</LinkCard>

pages/+config.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ export default {
2626
],
2727
clientRouting: true,
2828
supportsDarkMode: true,
29+
trailingSlash: false,
2930
meta: {
3031
supportsDarkMode: {
3132
env: {
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,5 @@ export default {
1010
"mdxContent",
1111
"title",
1212
],
13-
route: "/dev/docs*",
13+
route: "/docs*",
1414
} satisfies Config;

0 commit comments

Comments
 (0)