Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ jobs:
- name: Install dependencies
run: npm ci
- name: Build website
run: npm build
run: npm run build

- name: Upload Build Artifact
uses: actions/upload-pages-artifact@v3
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/test-deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,4 @@ jobs:
- name: Install dependencies
run: npm ci
- name: Test build website
run: npm build
run: npm run build
28 changes: 28 additions & 0 deletions adrs/2025-07-02-example.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
authors:
- ValentinGerlach # Change to your own handle. Add yourself to "authors.yml" if necessary.
---

# Example

## Context and Problem Statement

(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.)

## Considered Options

* (title of option 1)
* (title of option 2)
* (title of option 3)
* … <!-- numbers of options can vary -->

## Decision Outcome

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)).

<!-- This is an optional element. Feel free to remove. -->
### Consequences

* Good, because (positive consequence, e.g., improvement of one or more desired qualities, …)
* Bad, because (negative consequence, e.g., compromising one or more desired qualities, …)
* … <!-- numbers of consequences can vary -->
5 changes: 5 additions & 0 deletions docs/about/project.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
slug: /
---

# About this Project
1 change: 1 addition & 0 deletions docs/developers/getting-started.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Getting Started
1 change: 1 addition & 0 deletions docs/operators/getting-started.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Getting Started
1 change: 1 addition & 0 deletions docs/users/getting-started.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Getting Started
22 changes: 20 additions & 2 deletions docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -82,9 +82,27 @@ const config: Config = {
items: [
{
type: 'docSidebar',
sidebarId: 'main',
sidebarId: 'about',
position: 'left',
label: 'Docs',
label: 'About OpenMCP',
},
{
type: 'docSidebar',
sidebarId: 'userDocs',
position: 'left',
label: 'End-users',
},
{
type: 'docSidebar',
sidebarId: 'operatorDocs',
position: 'left',
label: 'Operators',
},
{
type: 'docSidebar',
sidebarId: 'developerDocs',
position: 'left',
label: 'Developers',
},
{to: '/adrs', label: 'ADRs', position: 'left'},
{
Expand Down
5 changes: 4 additions & 1 deletion sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,10 @@ import type {SidebarsConfig} from '@docusaurus/plugin-content-docs';
Create as many sidebars as you want.
*/
const sidebars: SidebarsConfig = {
main: [{type: 'autogenerated', dirName: '.'}],
about: [{type: 'autogenerated', dirName: 'about'}],
userDocs: [{type: 'autogenerated', dirName: 'users'}],
operatorDocs: [{type: 'autogenerated', dirName: 'operators'}],
developerDocs: [{type: 'autogenerated', dirName: 'developers'}],
};

export default sidebars;