diff --git a/astro.config.ts b/astro.config.ts
index 11c631b..20b81b6 100644
--- a/astro.config.ts
+++ b/astro.config.ts
@@ -37,7 +37,7 @@ export default defineConfig({
label: "Guides",
// items: [
// // Each item here is one entry in the navigation menu.
- // { label: "Get Started", slug: "guides/get-started" },
+ // { label: "Get Started", slug: "guides/1-get-started" },
// { label: "Example Guide", slug: "guides/example" },
// ],
autogenerate: { directory: "guides" },
diff --git a/src/content/docs/guides/1-get-started.mdx b/src/content/docs/guides/1-get-started.mdx
new file mode 100644
index 0000000..da400a2
--- /dev/null
+++ b/src/content/docs/guides/1-get-started.mdx
@@ -0,0 +1,72 @@
+---
+title: Get Started
+description: Get started with using Meru.
+sidebar:
+ order: 1
+---
+
+import { CardGrid, LinkCard } from "@astrojs/starlight/components";
+
+These docs are still a work in progress! We're actively building out the documentation alongside the project, so some sections may be incomplete or subject to change as we refine both the application and our documentation.
+
+## Guides
+
+{/* I plan to remove the numbers from the file names once I'm finished writing these docs. (ET) */}
+
+
+
+
+
+
+
+
+
+
+
+
+## Reference
+
+
+
+
+
diff --git a/src/content/docs/guides/keycloak.mdx b/src/content/docs/guides/2-keycloak.mdx
similarity index 100%
rename from src/content/docs/guides/keycloak.mdx
rename to src/content/docs/guides/2-keycloak.mdx
diff --git a/src/content/docs/guides/3-entity-details.mdx b/src/content/docs/guides/3-entity-details.mdx
new file mode 100644
index 0000000..5d08193
--- /dev/null
+++ b/src/content/docs/guides/3-entity-details.mdx
@@ -0,0 +1,123 @@
+---
+title: Entity Details
+description: Learn how to update details for entities.
+sidebar:
+ order: 3
+---
+
+import { Steps, Badge, Aside, LinkCard } from "@astrojs/starlight/components";
+
+
+
+## Access Entity Details
+
+
+
+1. Log in to the Meru Admin.
+2. Using Collections, Items, or search in the main navigation, navigate to the entity that you would like to update.
+3. Once you have the entity open, click on the **Manage** tab under the entity title. Click **Details** in the menu.
+
+
+
+## Update Entity Details
+
+### Update Hierarchical Level of Entity
+
+
+
+1. Find the **Parent** field.
+2. To change the parent of the entity, click on **Change**.
+3. The modal will show a list of child-level entities to the current parent. You can either navigate to a higher level using the back arrow **←**, or click on the forward arrow **→** next to an item to see its children.
+4. When you've found the new parent entity, click on it so that it is highlighted with a blue background and click **Save** at the bottom of the modal.
+5. Click **Save** at the bottom of the details page.
+
+
+
+ _Some entities will not be selectable. You
+will still be able to click on the right arrow to view their child entities._
+
+### Update Titles
+
+
+
+1. Find the **Title** and **Subtitle** fields.
+2. Enter or change the titles to your desired values.
+3. Click **Save** at the bottom of the details page.
+
+
+
+### Update Visibility
+
+
+
+1. Find **Visibility** on the details page.
+
+ _This is a required field. The default
+ value is **Visible**._
+
+2. Select the desired visibility level.
+
+ - **Visible** will make the entity and its children visible to users.
+ - **Hidden** will make the entity and its children invisible to users.
+ - **Limited** will make the entity and its children visible to users during a specified date range. Use the **Visible After** and/or **Visible Until** date selectors to define the range.
+
+3. Click **Save** at the bottom of the details page.
+
+
+
+### Update DOI
+
+
+
+1. Find **DOI** on the details page.
+2. _Explain DOI here._
+3. Click **Save** at the bottom of the details page.
+
+
+
+### Update Images
+
+
+
+1. Find the **Thumbnail** / **Hero Image** fields on the details page.
+2. Upload or drag and drop your desired images to the fields. See the [image uploading guidelines](/reference/image-guide) for sizing recommendations.
+3. Click **Save** at the bottom of the details page.
+
+
+
+### Update Summary
+
+
+
+1. Find the **Summary** field on the details page.
+2. Add summary text.
+3. Click **Save** at the bottom of the details page.
+
+
+
+### Update Publish Date
+
+
+
+1. Find the **Published** field on the details page.
+2. Add a year to the **Year** field.
+3. If desired, add **Month** and **Day**.
+4. Click **Save** at the bottom of the details page.
+
+
+
+### Update Schema
+
+ _Schema is defined when the entity is
+harvested. See the [Harvesting page](/guides/8-harvesting) for a detailed
+explanation._
+
+
+
+1. Find the **Schema** section on the details page.
+2. Click on **Change**.
+3. Select the correct schema.
+4. Add any details about the entity's schema to the **About** field.
+5. Click **Save** at the bottom of the details page.
+
+
diff --git a/src/content/docs/guides/4-entity-orderings.mdx b/src/content/docs/guides/4-entity-orderings.mdx
new file mode 100644
index 0000000..b4499e1
--- /dev/null
+++ b/src/content/docs/guides/4-entity-orderings.mdx
@@ -0,0 +1,71 @@
+---
+title: Entity Orderings
+description: Learn how to update orderings for entities.
+sidebar:
+ order: 4
+---
+
+import { Steps, Badge, Aside, LinkCard } from "@astrojs/starlight/components";
+
+
+
+## Access Entity Orderings
+
+
+
+1. Log in to the Meru Admin.
+2. Using Collections, Items, or search in the main navigation, navigate to the entity that you would like to update.
+3. Once you have the entity open, click on the **Manage** tab under the entity title. Click **Orderings** in the menu.
+
+
+
+## Add a New Entity Ordering
+
+
+
+1. Click on **Add Ordering +**.
+2. Add a **Name**. Common names include "Theses & Dissertations", "Papers", "Series", and "Books."
+3. Select the relationship of the entities to be included in the ordering.
+4. Select the schemas to be included in the ordering. If none are selected, all schemas will be permitted.
+5. Select the **Order By** criteria. Multiple options are permitted and can be reordered by dragging and dropping. At least one selection is required.
+6. Select whether to display the ordering as a **List** or **Tree**.
+7. Click **Save**.
+
+
+
+## Update an Existing Entity Ordering
+
+
+
+1. Hover over the desired ordering.
+2. Click on the button with the pencil icon.
+3. Make desired changes to the following fields:
+ - **Name**
+ - **Relationships**
+ - **Schemas**
+ - **Order By**
+ - **Display As**
+4. Click **Save**.
+
+
+
+## View an Existing Entity Ordering on the Frontend
+
+
+
+1. Hover over the desired ordering.
+2. Click on the button with the diagonal arrow.
+
+
+
+## Disable/Enable an Existing Entity Ordering
+
+
+
+1. Hover over the desired ordering.
+2. Click on the **Disable** button.
+3. You will be prompted to confirm your choice, click **Disable**, **Cancel**, or **Close**.
+4. If an entity ordering is Disabled and you would like to enable it again, click on **Enable**.
+5. You will be prompted to confirm your choice, click **Enable**, **Cancel**, or **Close**.
+
+
diff --git a/src/content/docs/guides/5-entity-links.mdx b/src/content/docs/guides/5-entity-links.mdx
new file mode 100644
index 0000000..80014b0
--- /dev/null
+++ b/src/content/docs/guides/5-entity-links.mdx
@@ -0,0 +1,42 @@
+---
+title: Entity Links
+description: Learn how to update links for entities.
+sidebar:
+ order: 5
+---
+
+import { Steps, Badge, Aside, LinkCard } from "@astrojs/starlight/components";
+
+
+
+## Access Entity Links
+
+
+
+1. Log in to the Meru Admin.
+2. Using Collections, Items, or search in the main navigation, navigate to the entity that you would like to update.
+3. Once you have the entity open, click on the **Manage** tab under the entity title. Click **Links** in the menu.
+
+
+
+## Add a New Entity Link
+
+
+
+1. Click on **Add Link +**.
+2. In the **Collection or Item** field, begin typing your entity link title. Matching entities will appear to choose from. _This may take a few seconds._
+3. Click on the desired entity title.
+4. If the linked entity is a descendent, select **Contains**. If it is a non-descended entity, select **reference**.
+5. Click **save**.
+
+
+
+## Remove an Entity Link
+
+
+
+1. Hover over the desired link.
+2. Click on the **Trash** icon.
+3. You will be prompted to confirm your choice. Click **Delete**, **Cancel**, or **Close**.
+
+
diff --git a/src/content/docs/guides/6-entity-access.mdx b/src/content/docs/guides/6-entity-access.mdx
new file mode 100644
index 0000000..8101a43
--- /dev/null
+++ b/src/content/docs/guides/6-entity-access.mdx
@@ -0,0 +1,40 @@
+---
+title: Entity Access
+description: Learn how to update access to entities.
+sidebar:
+ order: 6
+---
+
+import { Steps, Badge, Aside, LinkCard } from "@astrojs/starlight/components";
+
+
+
+## Navigate to Entity Access
+
+
+
+1. Log in to the Meru Admin.
+2. Using Collections, Items, or search in the main navigation, navigate to the entity that you would like to update.
+3. Once you have the entity open, click on the **Manage** tab under the entity title. Click **Access** in the menu.
+
+
+
+## Add Access to an Entity
+
+
+
+1. Click on **Add Access +**.
+2. In the **User** field, begin typing the user's name. Matching names will appear to choose from.
+3. Click on the desired name.
+4. Select the **role** of the user.
+
+ _Explain Role permissions
+ here._ - **Manager**: - **Editor**: - **Reader**:
+
+5. Click **save**.
+
+
+
+## Inherited Roles
+
+_Global Admins will have inherited roles for all entities. To view a list of non-inherited users who have access, click on **Hide Inherited Roles**._
diff --git a/src/content/docs/guides/users-contributers.mdx b/src/content/docs/guides/7-users-contributers.mdx
similarity index 88%
rename from src/content/docs/guides/users-contributers.mdx
rename to src/content/docs/guides/7-users-contributers.mdx
index f92b462..b145bcb 100644
--- a/src/content/docs/guides/users-contributers.mdx
+++ b/src/content/docs/guides/7-users-contributers.mdx
@@ -2,14 +2,14 @@
title: Users & Contributors
description: Learn how to manage users and contributors.
sidebar:
- order: 4
+ order: 7
---
import { Steps, Badge } from "@astrojs/starlight/components";
## Manage Users
-*Creating and removing users, as well as assigning administation privileges, is handled through the [Keycloak user dashboard](/guides/keycloak#creating-users), or users can register their own account directly from the Meru login screen. This section focuses on managing users after they've been created—resetting passwords, updating user details, and managing associated communities, collections, or items.*
+_Creating and removing users, as well as assigning administation privileges, is handled through the [Keycloak user dashboard](/guides/2-keycloak#creating-users), or users can register their own account directly from the Meru login screen. This section focuses on managing users after they've been created—resetting passwords, updating user details, and managing associated communities, collections, or items._
### Access User List
@@ -18,8 +18,8 @@ import { Steps, Badge } from "@astrojs/starlight/components";
1. Log in to the Meru Admin.
2. To get to the user list, go to **Manage** in the main navigation and click on **Users**.
- _Only those with `global_admin` privileges can edit user accounts._
-
+ _Only those with `global_admin`
+ privileges can edit user accounts._
3. The main page will show a list of all users in your Meru instance. You’ll see each user's name, email address, admin status, and creation date.
@@ -140,7 +140,7 @@ import { Steps, Badge } from "@astrojs/starlight/components";
## Manage Contributors
-*In most cases, contributors are automatically created via the harvesting process and don't need to be added by hand. However, Creating, editing, and removing contributors, both individual people and organizations, can also be done through the Contributors section of the Meru Admin. This section covers the full lifecycle of managing contributor records: creating new contributors, editing contributor details, managing their affiliations and contributions, viewing contributor profiles on the public site, and deleting contributors when needed.*
+_In most cases, contributors are automatically created via the harvesting process and don't need to be added by hand. However, Creating, editing, and removing contributors, both individual people and organizations, can also be done through the Contributors section of the Meru Admin. This section covers the full lifecycle of managing contributor records: creating new contributors, editing contributor details, managing their affiliations and contributions, viewing contributor profiles on the public site, and deleting contributors when needed._
### Access Contributor List
@@ -161,17 +161,18 @@ import { Steps, Badge } from "@astrojs/starlight/components";
3. Fill in the required fields: **First name** and **Last name**.
4. If you would like to upload an image, see the [image uploading guidelines](/reference/image-guide) for sizing recommendations.
5. Add any additional details:
- - Title
- - Affiliation
- - Email
- - ORCID Link
- - Bio
- - Additional links
+ - Title
+ - Affiliation
+ - Email
+ - ORCID Link
+ - Bio
+ - Additional links
6. Click **Save**.
- *Here is what those details will look like on the contributer details page:*
+ *Here is what those details will look like
+on the contributer details page:*
@@ -179,7 +180,6 @@ import { Steps, Badge } from "@astrojs/starlight/components";
#### View Contributor Detail Page
-
1. In the contributor list, hover over the contributor you want to view.
@@ -187,7 +187,8 @@ import { Steps, Badge } from "@astrojs/starlight/components";
- *This will navigate you out of admin and to the public contributor page on the frontend.*
+ *This will navigate you out of admin and to
+the public contributor page on the frontend.*
#### Delete a Contributor
@@ -202,8 +203,9 @@ import { Steps, Badge } from "@astrojs/starlight/components";
#### Edit Contributor Details
There are two ways to edit a contributor:
-- **Quick edit drawer** — *useful for making simple updates to contributor details.*
-- **Full contributor page** — *allows editing details as well as managing collection and item contributions.*
+
+- **Quick edit drawer** — _useful for making simple updates to contributor details._
+- **Full contributor page** — _allows editing details as well as managing collection and item contributions._
**_Quick Edit Drawer_**
@@ -238,9 +240,9 @@ There are two ways to edit a contributor:
3. Click **Create contribution +** at the top right of the page.
4. Fill in the required field: **Collection**.
5. Add any additional details:
- - Role
- - Role position
- - Overall position
+ - Role
+ - Role position
+ - Overall position
6. Click **Save**.
@@ -255,4 +257,4 @@ There are two ways to edit a contributor:
4. To update the position details for the user within that contribution, click on the button with the pencil icon. Make the desired changes and click **Save**. Role cannot be updated. To change a contributors role on entity, the contribution has to be deleted and a new one created.
5. Click on the community name to navigate to that community's detail page.
-
\ No newline at end of file
+
diff --git a/src/content/docs/guides/harvesting.mdx b/src/content/docs/guides/8-harvesting.mdx
similarity index 88%
rename from src/content/docs/guides/harvesting.mdx
rename to src/content/docs/guides/8-harvesting.mdx
index 7b07577..e009429 100644
--- a/src/content/docs/guides/harvesting.mdx
+++ b/src/content/docs/guides/8-harvesting.mdx
@@ -2,24 +2,18 @@
title: Harvesting
description: Learn how to configure sources, mappings, and attempts to harvest external content into Meru.
sidebar:
- order: 5
+ order: 8
---
-import { Aside, Steps, Badge, Card } from "@astrojs/starlight/components";
+import {
+ Aside,
+ Steps,
+ Badge,
+ Card,
+ LinkCard,
+} from "@astrojs/starlight/components";
-
+
## Access Harvesting Dashboard
diff --git a/src/content/docs/guides/global-settings.mdx b/src/content/docs/guides/9-global-settings.mdx
similarity index 90%
rename from src/content/docs/guides/global-settings.mdx
rename to src/content/docs/guides/9-global-settings.mdx
index 9f96572..0087ebd 100644
--- a/src/content/docs/guides/global-settings.mdx
+++ b/src/content/docs/guides/9-global-settings.mdx
@@ -2,14 +2,14 @@
title: Global Settings
description: Learn how to edit global settings.
sidebar:
- order: 6
+ order: 9
---
import { Steps, Badge } from "@astrojs/starlight/components";
## Edit Global Settings
-*Global settings apply to your entire Meru instance under your provider account. This is where you can update the site logo, configure controlled vocabularies, customize the theme, and manage global elements such as the footer.*
+_Global settings apply to your entire Meru instance under your provider account. This is where you can update the site logo, configure controlled vocabularies, customize the theme, and manage global elements such as the footer._
### Access Global Settings
@@ -18,8 +18,8 @@ import { Steps, Badge } from "@astrojs/starlight/components";
1. Log in to the Meru Admin.
2. To get to the global settings, go to **Manage** in the main navigation and click on **Global settings**.
- _The global settings are only visible to users with `global_admin` privileges._
-
+ _The global settings are only visible to
+ users with `global_admin` privileges._
3. A drawer will open up with all of the global settings fields.
@@ -55,4 +55,4 @@ import { Steps, Badge } from "@astrojs/starlight/components";
- **Footer Description** — The footer description displayed at the bottom of your installation’s pages. This field accepts basic markdown.
- **Copyright Statement** — The copyright information displayed in the footer. Example:
- **Copyright 2025 Meru**.
\ No newline at end of file
+ **Copyright 2025 Meru**.
diff --git a/src/content/docs/guides/get-started.mdx b/src/content/docs/guides/get-started.mdx
deleted file mode 100644
index 9b6746e..0000000
--- a/src/content/docs/guides/get-started.mdx
+++ /dev/null
@@ -1,25 +0,0 @@
----
-title: Get Started
-description: Get started with using Meru.
-sidebar:
- order: 1
----
-
-import { CardGrid, LinkCard } from "@astrojs/starlight/components";
-
-These docs are still a work in progress! We're actively building out the documentation alongside the project, so some sections may be incomplete or subject to change as we refine both the application and our documentation.
-
-## Guides
-
-
-
-
-
diff --git a/src/content/docs/index.mdx b/src/content/docs/index.mdx
index c1e8203..0f98e4a 100644
--- a/src/content/docs/index.mdx
+++ b/src/content/docs/index.mdx
@@ -6,6 +6,6 @@ hero:
tagline: These docs are still a work in progress! We're actively building out the documentation alongside the project, so some sections may be incomplete or subject to change as we refine both the application and our documentation.
actions:
- text: Get Started
- link: /guides/get-started
+ link: /guides/1-get-started
icon: right-arrow
---
diff --git a/src/content/docs/reference/glossary.mdx b/src/content/docs/reference/glossary.mdx
new file mode 100644
index 0000000..ba297cb
--- /dev/null
+++ b/src/content/docs/reference/glossary.mdx
@@ -0,0 +1,23 @@
+---
+title: Glossary
+description: A list of glossary terms commonly used throughout this documentation.
+---
+
+import { Badge } from "@astrojs/starlight/components";
+
+## General Terms
+
+| Term | Definition |
+| --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **Entity** | A generalized term used to refer to collections and items. The structure of these content types may vary depending on the context, and using a single term allows for consistent instructions across different levels of hierarchy. |
+| **Entity Link** | _Add entity link definition here._ |
+
+## Harvesting
+
+| Term | Definition |
+| ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **Harvesting Sources** | External systems that Meru is harvesting content from. For example, the URL of an OAIPMH feed. The harvesting source record would contain any protocol details or authentication. |
+| **Harvesting Sets** | Collections of content within a harvest source. In OAIPMH that would be a set that was exposed by the feed. They could represent a journal, departments, or grouped content in general. |
+| **Harvest Mappings** | Define the relationship between the content and the external sources and locations in Meru. They have templating logic that explains how we transform a piece of content or data in the harvested data to what we store in Meru. |
+| **Harvesting Attempts** | An individual event where Meru tries to retrieve and process content from a configured harvest source, based on the mappings and settings you've provided. |
+| **Harvest Records** | Singular flat collection of metadata that could be transformed into one or more entities in Meru. An OAIPMH feed typically doesn’t expose the full hierarchical structure of journal content. It doesn’t tell us the Journal → the volume → the issue → and the article. We just get the article and have to infer the hierarchy. A single harvest record can lead to multiple entities getting created in Meru. |
diff --git a/src/content/docs/reference/image-guide.mdx b/src/content/docs/reference/image-guide.mdx
index 0d67a5e..aa4b395 100644
--- a/src/content/docs/reference/image-guide.mdx
+++ b/src/content/docs/reference/image-guide.mdx
@@ -7,10 +7,10 @@ To ensure a crisp, professional appearance across all screen sizes—including r
## Image Specifications
-| Image Type | Recommended Size (px) | Resolution | Format | Notes |
-|------------|------------------------|------------|--------|-------|
-| Hero Image (One Column Layout) | 2880×980 | 72 ppi | JPG, PNG | Preferred size for all hero images. |
-| Hero Image (Two Column Layout) | 1440×980 | 72 ppi | JPG, PNG | |
-| Logo – Raster | 566×566 | 72 ppi | JPG, PNG | Ensures it looks crisp, especially on list pages. |
-| Logo – Vector | Scalable | — | SVG | Avoid excessive white space in the margins of the logo. |
-| Avatar | Minimum 100×100 | 300 ppi | JPG, PNG | Larger images are auto-resized. | |
\ No newline at end of file
+| Image Type | Recommended Size (px) | Resolution | Format | Notes |
+| ------------------------------ | --------------------- | ---------- | -------- | ------------------------------------------------------- | --- |
+| Hero Image (One Column Layout) | 2880×980 | 72 ppi | JPG, PNG | Preferred size for all hero images. |
+| Hero Image (Two Column Layout) | 1440×980 | 72 ppi | JPG, PNG | |
+| Logo – Raster | 566×566 | 72 ppi | JPG, PNG | Ensures it looks crisp, especially on list pages. |
+| Logo – Vector | Scalable | — | SVG | Avoid excessive white space in the margins of the logo. |
+| Avatar | Minimum 100×100 | 300 ppi | JPG, PNG | Larger images are auto-resized. | |