diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index 3a9f245..0c3574c 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -3,20 +3,21 @@ import { defineConfig } from 'vitepress'; export default defineConfig({ title: 'OpenArchiver Documentation', description: 'Official documentation for the OpenArchiver project.', + base: '/OpenArchiver/', themeConfig: { nav: [ - { text: 'Home', link: '/README' }, - { text: 'User Guides', link: '/user-guides/email-providers/README' } + { text: 'Home', link: '/' }, + { text: 'User Guides', link: '/user-guides/email-providers/' } ], sidebar: [ { text: 'User Guides', items: [ - { text: 'Get Started', link: '/README' }, + { text: 'Get Started', link: '/' }, { text: 'Installation', link: '/user-guides/installation' }, { text: 'Email Providers', - link: '/user-guides/email-providers/README', + link: '/user-guides/email-providers/', collapsed: true, items: [ { text: 'Google Workspace', link: '/user-guides/email-providers/google-workspace' }, @@ -29,14 +30,14 @@ export default defineConfig({ { text: 'API Reference', items: [ - { text: 'Overview', link: '/api/README' }, + { text: 'Overview', link: '/api/' }, { text: 'Ingestion API', link: '/api/ingestion' } ] }, { text: 'Services', items: [ - { text: 'Overview', link: '/services/README' }, + { text: 'Overview', link: '/services/' }, { text: 'Storage Service', link: '/services/storage-service' } ] } diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index d691f4f..71c69d8 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -2,16 +2,16 @@ ## User guides -- [Get started](README.md) +- [Get started](index.md) - [Installation](user-guides/installation.md) -- [email-providers](user-guides/email-providers/README.md) +- [email-providers](user-guides/email-providers/index.md) - [Connecting to Google Workspace](user-guides/email-providers/google-workspace.md) - [Connecting to a Generic IMAP Server](user-guides/email-providers/imap.md) - [Connecting to Microsoft 365](user-guides/email-providers/microsoft-365.md) --- -- [api](api/README.md) +- [api](api/index.md) - [Ingestion Sources API Documentation](api/ingestion.md) -- [services](services/README.md) +- [services](services/index.md) - [Pluggable Storage Service (StorageService)](services/storage-service.md) diff --git a/docs/api/README.md b/docs/api/index.md similarity index 100% rename from docs/api/README.md rename to docs/api/index.md diff --git a/docs/README.md b/docs/index.md similarity index 100% rename from docs/README.md rename to docs/index.md diff --git a/docs/services/README.md b/docs/services/index.md similarity index 100% rename from docs/services/README.md rename to docs/services/index.md diff --git a/docs/user-guides/email-providers/README.md b/docs/user-guides/email-providers/index.md similarity index 100% rename from docs/user-guides/email-providers/README.md rename to docs/user-guides/email-providers/index.md