Skip to content

Commit 95b2225

Browse files
fix: build (#6)
* fix: build * docs: add ADR example
1 parent bfbcace commit 95b2225

File tree

9 files changed

+62
-5
lines changed

9 files changed

+62
-5
lines changed

.github/workflows/deploy.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ jobs:
2323
- name: Install dependencies
2424
run: npm ci
2525
- name: Build website
26-
run: npm build
26+
run: npm run build
2727

2828
- name: Upload Build Artifact
2929
uses: actions/upload-pages-artifact@v3

.github/workflows/test-deploy.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,4 +23,4 @@ jobs:
2323
- name: Install dependencies
2424
run: npm ci
2525
- name: Test build website
26-
run: npm build
26+
run: npm run build

adrs/2025-07-02-example.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
authors:
3+
- ValentinGerlach # Change to your own handle. Add yourself to "authors.yml" if necessary.
4+
---
5+
6+
# Example
7+
8+
## Context and Problem Statement
9+
10+
(Describe the context and problem statement, e.g., in free form using two to three sentences or in the form of an illustrative story. You may want to articulate the problem in form of a question and add links to collaboration boards or issue management systems.)
11+
12+
## Considered Options
13+
14+
* (title of option 1)
15+
* (title of option 2)
16+
* (title of option 3)
17+
*<!-- numbers of options can vary -->
18+
19+
## Decision Outcome
20+
21+
Chosen option: "(title of option 1)", because (justification. e.g., only option, which meets k.o. criterion decision driver | which resolves force (force) | … | comes out best (see below)).
22+
23+
<!-- This is an optional element. Feel free to remove. -->
24+
### Consequences
25+
26+
* Good, because (positive consequence, e.g., improvement of one or more desired qualities, …)
27+
* Bad, because (negative consequence, e.g., compromising one or more desired qualities, …)
28+
*<!-- numbers of consequences can vary -->

docs/about/project.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
slug: /
3+
---
4+
5+
# About this Project

docs/developers/getting-started.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Getting Started

docs/operators/getting-started.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Getting Started

docs/users/getting-started.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Getting Started

docusaurus.config.ts

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -82,9 +82,27 @@ const config: Config = {
8282
items: [
8383
{
8484
type: 'docSidebar',
85-
sidebarId: 'main',
85+
sidebarId: 'about',
8686
position: 'left',
87-
label: 'Docs',
87+
label: 'About OpenMCP',
88+
},
89+
{
90+
type: 'docSidebar',
91+
sidebarId: 'userDocs',
92+
position: 'left',
93+
label: 'End-users',
94+
},
95+
{
96+
type: 'docSidebar',
97+
sidebarId: 'operatorDocs',
98+
position: 'left',
99+
label: 'Operators',
100+
},
101+
{
102+
type: 'docSidebar',
103+
sidebarId: 'developerDocs',
104+
position: 'left',
105+
label: 'Developers',
88106
},
89107
{to: '/adrs', label: 'ADRs', position: 'left'},
90108
{

sidebars.ts

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,10 @@ import type {SidebarsConfig} from '@docusaurus/plugin-content-docs';
1313
Create as many sidebars as you want.
1414
*/
1515
const sidebars: SidebarsConfig = {
16-
main: [{type: 'autogenerated', dirName: '.'}],
16+
about: [{type: 'autogenerated', dirName: 'about'}],
17+
userDocs: [{type: 'autogenerated', dirName: 'users'}],
18+
operatorDocs: [{type: 'autogenerated', dirName: 'operators'}],
19+
developerDocs: [{type: 'autogenerated', dirName: 'developers'}],
1720
};
1821

1922
export default sidebars;

0 commit comments

Comments
 (0)