Skip to content

Commit 55bbc2b

Browse files
committed
Fix broken links and clean up configuration
1 parent b7c30b1 commit 55bbc2b

3 files changed

Lines changed: 12 additions & 22 deletions

File tree

docs/api/overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,4 +70,4 @@ Headers included in responses:
7070

7171
## SDK
7272

73-
A TypeScript SDK is available for easy integration. Check out the [SDK Documentation](./sdk) for more details.
73+
A TypeScript SDK is available for easy integration. Check out the SDK Documentation for more details.

docs/guides/quick-start.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,4 +67,4 @@ The backend API will be available at `http://localhost:8000`
6767

6868
- Explore the [API Documentation](../api/overview)
6969
- Check out [Example Simulations](../examples/basic-simulation)
70-
- Learn about [Advanced Features](../guides/advanced-features)
70+
<!-- - Learn about [Advanced Features](../guides/advanced-features) -->

docusaurus.config.ts

Lines changed: 10 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -44,24 +44,10 @@ const config: Config = {
4444
sidebarPath: './sidebars.ts',
4545
// Please change this to your repo.
4646
editUrl:
47-
'https://github.com/hypurrstudio/illusio-docs/tree/main/docs-website/',
47+
'https://github.com/hypurrstudio/illusio-docs/',
4848
routeBasePath: '/', // Set docs as the default route
4949
},
50-
blog: {
51-
showReadingTime: true,
52-
feedOptions: {
53-
type: ['rss', 'atom'],
54-
xslt: true,
55-
},
56-
// Please change this to your repo.
57-
// Remove this to remove the "edit this page" links.
58-
// editUrl:
59-
// 'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/',
60-
// Useful options to enforce blogging best practices
61-
onInlineTags: 'warn',
62-
onInlineAuthors: 'warn',
63-
onUntruncatedBlogPosts: 'warn',
64-
},
50+
blog: false,
6551
theme: {
6652
customCss: './src/css/custom.css',
6753
},
@@ -92,16 +78,16 @@ const config: Config = {
9278
items: [
9379
{
9480
label: 'API Reference',
95-
to: '/docs/api/overview',
81+
to: '/api/overview',
9682
},
9783
{
9884
label: 'Examples',
99-
to: '/docs/examples/basic-simulation',
85+
to: '/examples/basic-simulation',
10086
},
10187
],
10288
},
10389
{
104-
href: 'https://github.com/hypurrstudio/illusio',
90+
href: 'https://github.com/hypurrstudio/illusio-docs',
10591
label: 'GitHub',
10692
position: 'right',
10793
},
@@ -113,6 +99,10 @@ const config: Config = {
11399
{
114100
title: 'Documentation',
115101
items: [
102+
{
103+
label: 'Introduction',
104+
to: '/',
105+
},
116106
{
117107
label: 'Getting Started',
118108
to: '/guides/quick-start',
@@ -136,7 +126,7 @@ const config: Config = {
136126
},
137127
{
138128
label: 'GitHub',
139-
href: 'https://github.com/hypurrstudio/illusio',
129+
href: 'https://github.com/hypurrstudio/illusio-docs',
140130
},
141131
],
142132
},

0 commit comments

Comments
 (0)