diff --git a/docs/docs/developer/open-api.md b/docs/docs/api.md similarity index 99% rename from docs/docs/developer/open-api.md rename to docs/docs/api.md index f627b2c459..edf58dc94d 100644 --- a/docs/docs/developer/open-api.md +++ b/docs/docs/api.md @@ -1,4 +1,4 @@ -# OpenAPI +# API Immich uses the [OpenAPI](https://swagger.io/specification/) standard to generate API documentation. To view the published docs see [here](https://api.immich.app/). diff --git a/docs/docs/developer/architecture.mdx b/docs/docs/developer/architecture.mdx index 42d9c1b974..954d264d55 100644 --- a/docs/docs/developer/architecture.mdx +++ b/docs/docs/developer/architecture.mdx @@ -24,7 +24,7 @@ Immich has three main clients: 3. CLI - Command-line utility for bulk upload :::info -All three clients use [OpenAPI](./open-api.md) to auto-generate rest clients for easy integration. For more information about this process, see [OpenAPI](./open-api.md). +All three clients use [OpenAPI](/api.md) to auto-generate rest clients for easy integration. For more information about this process, see [OpenAPI](/api.md). ::: ### Mobile App @@ -71,7 +71,7 @@ An incoming HTTP request is mapped to a controller (`src/controllers`). Controll ### Domain Transfer Objects (DTOs) -The server uses [Domain Transfer Objects](https://en.wikipedia.org/wiki/Data_transfer_object) as public interfaces for the inputs (query, params, and body) and outputs (response) for each endpoint. DTOs translate to [OpenAPI](./open-api.md) schemas and control the generated code used by each client. +The server uses [Domain Transfer Objects](https://en.wikipedia.org/wiki/Data_transfer_object) as public interfaces for the inputs (query, params, and body) and outputs (response) for each endpoint. DTOs translate to [OpenAPI](/api.md) schemas and control the generated code used by each client. ### Background Jobs diff --git a/docs/docs/developer/pr-checklist.md b/docs/docs/developer/pr-checklist.md index e68567bc8f..e5dc6cc1e5 100644 --- a/docs/docs/developer/pr-checklist.md +++ b/docs/docs/developer/pr-checklist.md @@ -53,7 +53,7 @@ You can use `dart fix --apply` and `dcm fix lib` to potentially correct some iss ## OpenAPI -The OpenAPI client libraries need to be regenerated whenever there are changes to the `immich-openapi-specs.json` file. Note that you should not modify this file directly as it is auto-generated. See [OpenAPI](/developer/open-api.md) for more details. +The OpenAPI client libraries need to be regenerated whenever there are changes to the `immich-openapi-specs.json` file. Note that you should not modify this file directly as it is auto-generated. See [OpenAPI](/api.md) for more details. ## Database Migrations diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index 147f981aff..00a120b8b6 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -6,7 +6,7 @@ const prism = require('prism-react-renderer'); /** @type {import('@docusaurus/types').Config} */ const config = { title: 'Immich', - tagline: 'High performance self-hosted photo and video backup solution directly from your mobile phone', + tagline: 'Self-hosted photo and video management solution', url: 'https://docs.immich.app', baseUrl: '/', onBrokenLinks: 'throw', @@ -93,35 +93,15 @@ const config = { position: 'right', }, { - to: '/overview/quick-start', + href: 'https://immich.app/', position: 'right', - label: 'Docs', - }, - { - href: 'https://immich.app/roadmap', - position: 'right', - label: 'Roadmap', - }, - { - href: 'https://api.immich.app/', - position: 'right', - label: 'API', - }, - { - href: 'https://immich.store', - position: 'right', - label: 'Merch', + label: 'Home', }, { href: 'https://github.com/immich-app/immich', label: 'GitHub', position: 'right', }, - { - href: 'https://discord.immich.app', - label: 'Discord', - position: 'right', - }, { type: 'html', position: 'right', @@ -134,19 +114,78 @@ const config = { style: 'light', links: [ { - title: 'Overview', + title: 'Download', items: [ { - label: 'Quick start', - to: '/overview/quick-start', + label: 'Android', + href: 'https://get.immich.app/android', }, { - label: 'Installation', - to: '/install/requirements', + label: 'iOS', + href: 'https://get.immich.app/ios', }, { - label: 'Contributing', - to: '/overview/support-the-project', + label: 'Server', + href: 'https://immich.app/download', + }, + ], + }, + { + title: 'Company', + items: [ + { + label: 'FUTO', + href: 'https://futo.tech/', + }, + { + label: 'Purchase', + href: 'https://buy.immich.app/', + }, + { + label: 'Merch', + href: 'https://immich.store/', + }, + ], + }, + { + title: 'Sites', + items: [ + { + label: 'Home', + href: 'https://immich.app', + }, + { + label: 'My Immich', + href: 'https://my.immich.app/', + }, + { + label: 'Awesome Immich', + href: 'https://awesome.immich.app/', + }, + { + label: 'Immich API', + href: 'https://api.immich.app/', + }, + { + label: 'Immich Data', + href: 'https://data.immich.app/', + }, + { + label: 'Immich Datasets', + href: 'https://datasets.immich.app/', + }, + ], + }, + { + title: 'Miscellaneous', + items: [ + { + label: 'Roadmap', + href: 'https://immich.app/roadmap', + }, + { + label: 'Cursed Knowledge', + href: 'https://immich.app/cursed-knowledge', }, { label: 'Privacy Policy', @@ -155,24 +194,7 @@ const config = { ], }, { - title: 'Documentation', - items: [ - { - label: 'Roadmap', - href: 'https://immich.app/roadmap', - }, - { - label: 'API', - href: 'https://api.immich.app/', - }, - { - label: 'Cursed Knowledge', - href: 'https://immich.app/cursed-knowledge', - }, - ], - }, - { - title: 'Links', + title: 'Social', items: [ { label: 'GitHub', diff --git a/docs/static/_redirects b/docs/static/_redirects index 5d4ad14f00..218bb71d69 100644 --- a/docs/static/_redirects +++ b/docs/static/_redirects @@ -23,6 +23,7 @@ /features/storage-template /administration/storage-template 307 /features/user-management /administration/user-management 307 /developer/contributing /developer/pr-checklist 307 +/developer/open-api /api 307 /guides/machine-learning /guides/remote-machine-learning 307 /administration/password-login /administration/system-settings 307 /features/search /features/searching 307