diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index 0eba570..2e1e5d5 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -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 diff --git a/.github/workflows/test-deploy.yml b/.github/workflows/test-deploy.yml index 9e00e31..2294d83 100644 --- a/.github/workflows/test-deploy.yml +++ b/.github/workflows/test-deploy.yml @@ -23,4 +23,4 @@ jobs: - name: Install dependencies run: npm ci - name: Test build website - run: npm build + run: npm run build diff --git a/adrs/2025-07-02-example.md b/adrs/2025-07-02-example.md new file mode 100644 index 0000000..264780f --- /dev/null +++ b/adrs/2025-07-02-example.md @@ -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) +* … + +## 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)). + + +### 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, …) +* … diff --git a/docs/about/project.md b/docs/about/project.md new file mode 100644 index 0000000..542ab18 --- /dev/null +++ b/docs/about/project.md @@ -0,0 +1,5 @@ +--- +slug: / +--- + +# About this Project diff --git a/docs/developers/getting-started.md b/docs/developers/getting-started.md new file mode 100644 index 0000000..bad5562 --- /dev/null +++ b/docs/developers/getting-started.md @@ -0,0 +1 @@ +# Getting Started diff --git a/docs/operators/getting-started.md b/docs/operators/getting-started.md new file mode 100644 index 0000000..bad5562 --- /dev/null +++ b/docs/operators/getting-started.md @@ -0,0 +1 @@ +# Getting Started diff --git a/docs/users/getting-started.md b/docs/users/getting-started.md new file mode 100644 index 0000000..bad5562 --- /dev/null +++ b/docs/users/getting-started.md @@ -0,0 +1 @@ +# Getting Started diff --git a/docusaurus.config.ts b/docusaurus.config.ts index 3a18857..098246a 100644 --- a/docusaurus.config.ts +++ b/docusaurus.config.ts @@ -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'}, { diff --git a/sidebars.ts b/sidebars.ts index de49c59..2b8608f 100644 --- a/sidebars.ts +++ b/sidebars.ts @@ -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;