Skip to content

Commit d76d0a1

Browse files
updated images and fixed default import of swaggerAPIDoc component
1 parent 0a8831c commit d76d0a1

File tree

7 files changed

+10
-9
lines changed

7 files changed

+10
-9
lines changed

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
21
# Overture Docs
32

43
Overture Docs is a centralized documentation site built with [Docusaurus](https://docusaurus.io/) that aggregates and renders Markdown content from `/docs` directories across our GitHub repositories. It transforms distributed documentation into a cohesive and easy to navigate knowledge base.
@@ -12,13 +11,16 @@ Overture Docs is a centralized documentation site built with [Docusaurus](https:
1211

1312
### Running it Locally
1413

15-
To clone the repository with the files in the submodules:
14+
1. clone the repository with the submodules:
1615

1716
```bash
1817
git clone --recurse-submodules https://github.com/overture-stack/docs.git
1918
```
2019

21-
Install required dependencies:
20+
> [!TIP]
21+
> Already cloned the repo? You can still get the submodules by running: `git submodule update --init --recursive`
22+
23+
2. Install required dependencies:
2224

2325
```
2426
npm ci

submodules/lectern

submodules/lyric

website/docs/02-under-development/images/submission-system.svg

Lines changed: 1 addition & 2 deletions
Loading

website/src/components/SwaggerAPIDoc/scoreAPI.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
{
22
"swagger": "2.0",
3-
"host": "score.demo.overture.bio",
43
"basePath": "/",
54
"tags": [
65
{

website/src/components/SwaggerAPIDoc/songAPI.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
{
22
"swagger": "2.0",
3-
"host": "song.demo.overture.bio",
43
"basePath": "/",
54
"tags": [
65
{

website/src/theme/MDXComponents.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ import MDXComponents from '@theme-original/MDXComponents';
33
import Tabs from '@theme/Tabs';
44
import TabItem from '@theme/TabItem';
55
import DocCardList from '@theme/DocCardList'
6+
import SwaggerAPIDoc from '../components/SwaggerAPIDoc';
67

78

89
const components: typeof MDXComponents & {
@@ -14,6 +15,7 @@ const components: typeof MDXComponents & {
1415
Tabs,
1516
TabItem,
1617
DocCardList,
18+
SwaggerAPIDoc,
1719
};
1820

1921
export default components;

0 commit comments

Comments
 (0)