Skip to content

Commit 2db7378

Browse files
widal001widal001
authored
[Issue #26] Update website content (#45)
* refactor: Removes old Starlight content * feat: Adds new placeholder content and an about page * feat: Adds support for "Edit page" link to each page * docs: Updates README with protocol working title * ci: Adds starlight-link-validator and fixes broken links
1 parent 69b841e commit 2db7378

File tree

17 files changed

+190
-59
lines changed

17 files changed

+190
-59
lines changed

‎.github/workflows/ci-website.yml

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -38,12 +38,5 @@ jobs:
3838
- name: Build site
3939
run: npm run build
4040

41-
- name: Check links
42-
uses: lycheeverse/[email protected]
43-
with:
44-
# Check the links in the html files in the output directory
45-
# that were generated by `npm run build`
46-
args: ./dist/
47-
4841
- name: Audit dependencies
4942
run: npm audit

‎website/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Simpler grant protocol website
1+
# CommonGrants protocol website
22

3-
Code for the [simpler grant protocol website](https://hhs.github.io/simpler-grants-protocol/) and public docs. This site is built using the [Starlight docs](https://starlight.astro.build/) from Astro and hosted on GitHub pages.
3+
Code for the [CommonGrants protocol website](https://hhs.github.io/simpler-grants-protocol/) and public docs. This site is built using the [Starlight docs](https://starlight.astro.build/) from Astro and hosted on GitHub pages.
44

55
## 🚀 Project Structure
66

‎website/astro.config.mjs

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
// @ts-check
22
import { defineConfig } from "astro/config";
33
import starlight from "@astrojs/starlight";
4+
import starlightLinksValidator from "starlight-links-validator";
45

56
// https://astro.build/config
67
export default defineConfig({
@@ -9,11 +10,23 @@ export default defineConfig({
910
base: "simpler-grants-protocol/",
1011
integrations: [
1112
starlight({
12-
title: "Simpler Grant Protocol",
13+
plugins: [starlightLinksValidator()],
14+
title: "CommonGrants",
1315
social: {
1416
github: "https://github.com/HHS/simpler-grants-protocol",
1517
},
18+
editLink: {
19+
baseUrl:
20+
"https://github.com/HHS/simpler-grants-protocol/edit/main/website/",
21+
},
1622
sidebar: [
23+
{
24+
label: "Welcome",
25+
items: [
26+
{ label: "Getting started", link: "getting-started" },
27+
{ label: "About CommonGrants", link: "about" },
28+
],
29+
},
1730
{
1831
label: "Guides",
1932
autogenerate: { directory: "guides" },

‎website/package-lock.json

Lines changed: 45 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎website/package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@
3030
"eslint-plugin-astro": "^1.3.1",
3131
"globals": "^15.14.0",
3232
"prettier": "3.4.2",
33+
"starlight-links-validator": "^0.14.1",
3334
"typescript-eslint": "^8.18.2"
3435
}
3536
}

‎website/src/content/docs/about.mdx

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
title: About CommonGrants
3+
description: Learn about the CommonGrants protocol and its mission.
4+
---
5+
6+
**CommonGrants** is an open standard designed to streamline the process of discovering, applying to, and reporting on funding opportunities across the grant ecosystem.
7+
8+
## Core principles
9+
10+
The principles that guide the design of the CommonGrants protocol include:
11+
12+
- **Standardization**: Define a consistent format for sharing grant data
13+
- **Extensibility**: Support customization without breaking integrations
14+
- **Interoperability**: Enable teams to build tools that work across grant platforms
15+
- **Portability**: Allow users to own and move their data between systems
16+
17+
## Vision
18+
19+
The CommonGrants protocol envisions a future in which:
20+
21+
- Grant makers can publish to one platform, and be discovered on any platform
22+
- Grant seekers can find opportunities based on fit, not which portals they've subscribed to
23+
- Grant applicants can focus on delivering impact, instead of translating it between application formats
24+
- Grant platforms can compete for users based on feature quality, rather than on data quantity
25+
26+
## Inspiration
27+
28+
The CommonGrants protocol builds on the design and approach of several existing standards and protocols, including:
29+
30+
- [JSON Schema](https://json-schema.org/) - For defining and validating standardized data formats
31+
- [OpenAPI](https://swagger.io/docs/specification/about/) - For specifying consistent APIs and interfaces
32+
- [FHIR](https://www.hl7.org/fhir/) - For establishing shared data standards across an industry
33+
- [ActivityPub](https://www.w3.org/TR/activitypub/) - For enabling decentralized data exchange between platforms
34+
35+
## Dive deeper
36+
37+
- [Implement a CommonGrants API from scratch](/simpler-grants-protocol/guides/build-an-api/)
38+
- [Migrate an existing API to the CommonGrants protocol](/simpler-grants-protocol/guides/build-an-api/)

‎website/src/content/docs/decisions/adr/0001-using-adrs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ What is the best way to document key architectural decisions made within the pro
1111

1212
### Decision outcome
1313

14-
We've decided to use Architecture Decision Records (ADRs) as described in [Recording decisions](../../overview). These records will be published on the website for this project.
14+
We've decided to use Architecture Decision Records (ADRs) as described in [Recording decisions](/simpler-grants-protocol/decisions/overview). These records will be published on the website for this project.
1515

1616
- **Positive consequences**
1717
- Decisions are documented explicitly

‎website/src/content/docs/decisions/overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Almost all of engineering and code development involves making choices, so how d
1919

2020
> An Architectural Decision (AD) is a software design choice that addresses a functional or non-functional requirement that is architecturally significant.
2121
>
22-
> Source: [ADR GitHub Organization](adr)
22+
> Source: [ADR GitHub Organization][adr]
2323
2424
Another way to recognize when making a decision related to your project constitutes an architecture decision is to ask yourself three questions about that decision:
2525

‎website/src/content/docs/getting-started.mdx

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
title: Getting started
3+
description: Get started with the CommonGrants protocol.
4+
---
5+
6+
Welcome to the CommonGrants protocol documentation. This guide will help you get started with understanding and implementing the protocol.
7+
8+
## What is CommonGrants?
9+
10+
CommonGrants is a protocol designed to standardize how data about funding opportunities, applications, and awards is shared across the grant ecosystem.
11+
12+
## Quickstart
13+
14+
:::note[TODO]
15+
Create a quickstart guide
16+
:::
17+
18+
## Learn more
19+
20+
- [About CommonGrants](/simpler-grants-protocol/about/)
21+
- [Specification](/simpler-grants-protocol/reference/specification/)

‎website/src/content/docs/guides/build-an-api.mdx

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
title: Build a CommonGrants API
3+
description: Learn how to build a CommonGrants-compatible API from a specification.
4+
sidebar:
5+
order: 1
6+
---
7+
8+
Learn how to build a CommonGrants-compatible API from scratch using TypeSpec.
9+
10+
:::note[TODO]
11+
Fill out the rest of this guide
12+
:::

‎website/src/content/docs/guides/example.md

Lines changed: 0 additions & 11 deletions
This file was deleted.

‎website/src/content/docs/guides/index.md

Lines changed: 0 additions & 8 deletions
This file was deleted.

‎website/src/content/docs/guides/migrate-an-api.mdx

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
title: Migrate an existing API
3+
description: Learn how to migrate an existing API to the CommonGrants protocol.
4+
sidebar:
5+
order: 2
6+
---
7+
8+
Learn how to migrate an existing API to the CommonGrants protocol.
9+
10+
:::note[TODO]
11+
Fill out the rest of this guide
12+
:::

‎website/src/content/docs/guides/publish-custom-fields.mdx

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
title: Share your custom fields
3+
description: Learn how to publish your custom fields and types as a reusable npm library.
4+
sidebar:
5+
order: 3
6+
---
7+
8+
Learn how to publish your custom fields and types as a reusable npm library.
9+
10+
:::note[TODO]
11+
Fill out the rest of this guide
12+
:::

‎website/src/content/docs/index.mdx

Lines changed: 21 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,38 @@
11
---
2-
title: Simpler Grant Protocol
3-
description: Learn more about the simpler grant protocol.
2+
title: CommonGrants protocol
3+
description: Documentation for the CommonGrants protocol
44
template: splash
55
hero:
6-
tagline: Integrating data across the grants ecosystem.
6+
tagline: An open standard for sharing data about funding opportunities, applications, and awards across the grant ecosystem
77
actions:
8-
- text: Example Guide
9-
link: guides/example/
8+
- text: Get started
9+
link: /simpler-grants-protocol/getting-started/
1010
icon: right-arrow
11-
- text: Visit our GitHub repo
12-
link: https://github.com/HHS/simpler-grants-protocol
13-
icon: external
11+
- text: Learn more
12+
link: /simpler-grants-protocol/about/
13+
icon: open-book
1414
variant: minimal
1515
---
1616

1717
import { Card, CardGrid } from "@astrojs/starlight/components";
1818

19-
## Next steps
19+
## Quick links
2020

2121
<CardGrid stagger>
22-
<Card title="Update content" icon="pencil">
23-
Edit `src/content/docs/index.mdx` to see this page change.
22+
<Card title="Get started" icon="rocket">
23+
[Get started](/simpler-grants-protocol/getting-started/) with the
24+
CommonGrants protocol.
2425
</Card>
25-
<Card title="Add new content" icon="add-document">
26-
Add Markdown or MDX files to `src/content/docs` to create new pages.
26+
<Card title="Read the guides" icon="open-book">
27+
Learn how to [use and
28+
implement](/simpler-grants-protocol/guides/build-an-api/) the protocol.
2729
</Card>
28-
<Card title="Configure your site" icon="setting">
29-
Edit your `sidebar` and other config in `astro.config.mjs`.
30+
<Card title="Explore the spec" icon="document">
31+
Review the [technical
32+
specification](/simpler-grants-protocol/reference/specification/).
3033
</Card>
31-
<Card title="Read the docs" icon="open-book">
32-
Learn more in [the Starlight Docs](https://starlight.astro.build/).
34+
<Card title="Follow our process" icon="setting">
35+
Learn about [decision making
36+
process](/simpler-grants-protocol/decisions/overview/).
3337
</Card>
3438
</CardGrid>

‎website/src/content/docs/reference/example.md

Lines changed: 0 additions & 11 deletions
This file was deleted.

‎website/src/content/docs/reference/specification.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
title: Specification
3+
description: A specification for the CommonGrants protocol.
4+
---
5+
6+
A specification for the CommonGrants protocol.
7+
8+
:::note[TODO]
9+
Draft the specification
10+
:::

0 commit comments

Comments
 (0)