Skip to content

Commit 29717ef

Browse files
widal001widal001
authored
[Issue #33] Update site URL (#119)
* refactor: Removes base path * refactor: Update links to remove base path * ci: Fixes formatting
1 parent 82c1a6e commit 29717ef

24 files changed

Lines changed: 243 additions & 249 deletions

‎website/astro.config.mjs‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,6 @@ import starlightOpenAPI, { openAPISidebarGroups } from "starlight-openapi";
77
// https://astro.build/config
88
export default defineConfig({
99
site: "https://hhs.github.io",
10-
// Base needs trailing slash to make relative links work when hosting locally
11-
base: "simpler-grants-protocol/",
1210
integrations: [
1311
starlight({
1412
plugins: [
@@ -22,7 +20,7 @@ export default defineConfig({
2220
]),
2321
starlightLinksValidator({
2422
errorOnLocalLinks: false,
25-
exclude: ["/simpler-grants-protocol/protocol/openapi/**"],
23+
exclude: ["/protocol/openapi/**"],
2624
}),
2725
],
2826
title: "CommonGrants",

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,6 @@ The CommonGrants protocol builds on the design and approach of several existing
3434

3535
## Dive deeper
3636

37-
- [Read the specification](/simpler-grants-protocol/protocol/specification/)
38-
- [Explore the core library](/simpler-grants-protocol/protocol/overview/)
39-
- [View the open API spec](/simpler-grants-protocol/protocol/openapi/)
37+
- [Read the specification](/protocol/specification/)
38+
- [Explore the core library](/protocol/overview/)
39+
- [View the open API spec](/protocol/openapi/)

‎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](/simpler-grants-protocol/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](/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/getting-started.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -471,8 +471,8 @@ This should start a local server that serves the OpenAPI specification using Swa
471471

472472
Learn more about the CommonGrants protocol:
473473

474-
- [About CommonGrants](/simpler-grants-protocol/about/)
475-
- [Specification](/simpler-grants-protocol/protocol/specification/)
474+
- [About CommonGrants](/about/)
475+
- [Specification](/protocol/specification/)
476476

477477
Learn more about TypeSpec:
478478

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

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@ hero:
66
tagline: An open standard for sharing data about funding opportunities, applications, and awards across the grant ecosystem
77
actions:
88
- text: Get started
9-
link: /simpler-grants-protocol/getting-started/
9+
link: /getting-started/
1010
icon: right-arrow
1111
- text: Learn more
12-
link: /simpler-grants-protocol/about/
12+
link: /about/
1313
icon: open-book
1414
variant: minimal
1515
---
@@ -20,19 +20,15 @@ import { Card, CardGrid } from "@astrojs/starlight/components";
2020

2121
<CardGrid stagger>
2222
<Card title="Get started" icon="rocket">
23-
[Get started](/simpler-grants-protocol/getting-started/) with the
24-
CommonGrants protocol.
23+
[Get started](/getting-started/) with the CommonGrants protocol.
2524
</Card>
2625
<Card title="Read the guides" icon="open-book">
27-
Learn how to [use and
28-
implement](/simpler-grants-protocol/guides/using-python/) the protocol.
26+
Learn how to [use and implement](/guides/using-python/) the protocol.
2927
</Card>
3028
<Card title="Explore the spec" icon="document">
31-
Review the [technical
32-
specification](/simpler-grants-protocol/protocol/specification/).
29+
Review the [technical specification](/protocol/specification/).
3330
</Card>
3431
<Card title="Follow our process" icon="setting">
35-
Learn about [decision making
36-
process](/simpler-grants-protocol/decisions/overview/).
32+
Learn about [decision making process](/decisions/overview/).
3733
</Card>
3834
</CardGrid>

‎website/src/content/docs/protocol/fields/custom-field.mdx‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,13 @@ A model for defining custom fields on a record.
1313
<Tabs>
1414
<TabItem label="Table">
1515

16-
| Property | Type | Required | Description |
17-
| ----------- | --------------------------------------------------------------- | -------- | --------------------------------------------------------- |
18-
| name | [string](/simpler-grants-protocol/protocol/types/string#string) | Yes | Name of the custom field |
19-
| type | [CustomFieldType](#customfieldtype) | Yes | The JSON schema type to use when de-serializing the value |
20-
| schema | [url](/simpler-grants-protocol/protocol/types/string#url) | No | Link to the full JSON schema for this custom field |
21-
| value | any | Yes | Value of the custom field |
22-
| description | [string](/simpler-grants-protocol/protocol/types/string#string) | No | Description of the custom field's purpose |
16+
| Property | Type | Required | Description |
17+
| ----------- | --------------------------------------- | -------- | --------------------------------------------------------- |
18+
| name | [string](/protocol/types/string#string) | Yes | Name of the custom field |
19+
| type | [CustomFieldType](#customfieldtype) | Yes | The JSON schema type to use when de-serializing the value |
20+
| schema | [url](/protocol/types/string#url) | No | Link to the full JSON schema for this custom field |
21+
| value | any | Yes | Value of the custom field |
22+
| description | [string](/protocol/types/string#string) | No | Description of the custom field's purpose |
2323

2424
</TabItem>
2525

‎website/src/content/docs/protocol/fields/event.mdx‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,12 @@ A description of an event with an associated date (and possible time).
1515
<Tabs>
1616
<TabItem label="Table">
1717

18-
| Property | Type | Required | Description |
19-
| ----------- | --------------------------------------------------------------- | -------- | --------------------------------------------------- |
20-
| name | [string](/simpler-grants-protocol/protocol/types/string#string) | Yes | Human-readable name of the event |
21-
| date | [isoDate](/simpler-grants-protocol/protocol/types/date#isodate) | Yes | Date of the event in in ISO 8601 format: YYYY-MM-DD |
22-
| time | [isoTime](/simpler-grants-protocol/protocol/types/date#isotime) | No | Time of the event in in ISO 8601 format: HH:MM:SS |
23-
| description | [string](/simpler-grants-protocol/protocol/types/string#string) | No | A description of the event |
18+
| Property | Type | Required | Description |
19+
| ----------- | --------------------------------------- | -------- | --------------------------------------------------- |
20+
| name | [string](/protocol/types/string#string) | Yes | Human-readable name of the event |
21+
| date | [isoDate](/protocol/types/date#isodate) | Yes | Date of the event in in ISO 8601 format: YYYY-MM-DD |
22+
| time | [isoTime](/protocol/types/date#isotime) | No | Time of the event in in ISO 8601 format: HH:MM:SS |
23+
| description | [string](/protocol/types/string#string) | No | A description of the event |
2424

2525
</TabItem>
2626

‎website/src/content/docs/protocol/fields/index.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,16 +11,16 @@ The `CommonGrants.Fields` namespace contains a standard set of fields that are u
1111

1212
Learn more about the standard fields defined by the CommonGrants protocol:
1313

14-
| Field | Description |
15-
| -------------------------------------------------------------------- | ------------------------------------------------- |
16-
| [Money](/simpler-grants-protocol/protocol/fields/money) | A monetary amount with a currency code |
17-
| [Event](/simpler-grants-protocol/protocol/fields/event) | A description of an event with an associated date |
18-
| [CustomField](/simpler-grants-protocol/protocol/fields/custom-field) | A model for defining custom fields on a record |
19-
| [SystemMetadata](/simpler-grants-protocol/protocol/fields/metadata) | System-managed metadata for records |
14+
| Field | Description |
15+
| -------------------------------------------- | ------------------------------------------------- |
16+
| [Money](/protocol/fields/money) | A monetary amount with a currency code |
17+
| [Event](/protocol/fields/event) | A description of an event with an associated date |
18+
| [CustomField](/protocol/fields/custom-field) | A model for defining custom fields on a record |
19+
| [SystemMetadata](/protocol/fields/metadata) | System-managed metadata for records |
2020

2121
## Usage
2222

23-
You can use the fields listed above (along with basic [data types](/simpler-grants-protocol/protocol/types/)) above to define custom models in your TypeSpec project.
23+
You can use the fields listed above (along with basic [data types](/protocol/types/)) above to define custom models in your TypeSpec project.
2424

2525
```typespec
2626
import "@common-grants/core"

‎website/src/content/docs/protocol/fields/metadata.mdx‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,10 @@ System-managed metadata that is automatically added to records.
1313
<Tabs>
1414
<TabItem label="Table">
1515

16-
| Property | Type | Required | Description |
17-
| -------------- | ----------------------------------------------------------------------- | -------- | ------------------------------------------------------------ |
18-
| createdAt | [utcDateTime](/simpler-grants-protocol/protocol/types/date#utcdatetime) | Yes | The timestamp (in UTC) at which the record was created |
19-
| lastModifiedAt | [utcDateTime](/simpler-grants-protocol/protocol/types/date#utcdatetime) | Yes | The timestamp (in UTC) at which the record was last modified |
16+
| Property | Type | Required | Description |
17+
| -------------- | ----------------------------------------------- | -------- | ------------------------------------------------------------ |
18+
| createdAt | [utcDateTime](/protocol/types/date#utcdatetime) | Yes | The timestamp (in UTC) at which the record was created |
19+
| lastModifiedAt | [utcDateTime](/protocol/types/date#utcdatetime) | Yes | The timestamp (in UTC) at which the record was last modified |
2020

2121
</TabItem>
2222

‎website/src/content/docs/protocol/fields/money.mdx‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,10 @@ A monetary amount and the currency in which it is denominated.
1515
<Tabs>
1616
<TabItem label="Table">
1717

18-
| Property | Type | Required | Description |
19-
| -------- | ------------------------------------------------------------------------------ | -------- | ----------------------------------------------- |
20-
| amount | [decimalString](/simpler-grants-protocol/protocol/types/numeric#decimalstring) | Yes | The amount of money |
21-
| currency | [string](/simpler-grants-protocol/protocol/types/string#string) | Yes | The ISO 4217 currency code (e.g., "USD", "EUR") |
18+
| Property | Type | Required | Description |
19+
| -------- | ------------------------------------------------------ | -------- | ----------------------------------------------- |
20+
| amount | [decimalString](/protocol/types/numeric#decimalstring) | Yes | The amount of money |
21+
| currency | [string](/protocol/types/string#string) | Yes | The ISO 4217 currency code (e.g., "USD", "EUR") |
2222

2323
</TabItem>
2424

0 commit comments

Comments
 (0)