Skip to content

Commit fae0527

Browse files
authored
feat: doc links (immich-app#26519)
1 parent 771816f commit fae0527

File tree

5 files changed

+64
-41
lines changed

5 files changed

+64
-41
lines changed
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# OpenAPI
1+
# API
22

33
Immich uses the [OpenAPI](https://swagger.io/specification/) standard to generate API documentation. To view the published docs see [here](https://api.immich.app/).
44

docs/docs/developer/architecture.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Immich has three main clients:
2424
3. CLI - Command-line utility for bulk upload
2525

2626
:::info
27-
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).
27+
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).
2828
:::
2929

3030
### Mobile App
@@ -71,7 +71,7 @@ An incoming HTTP request is mapped to a controller (`src/controllers`). Controll
7171

7272
### Domain Transfer Objects (DTOs)
7373

74-
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.
74+
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.
7575

7676
### Background Jobs
7777

docs/docs/developer/pr-checklist.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ You can use `dart fix --apply` and `dcm fix lib` to potentially correct some iss
5353

5454
## OpenAPI
5555

56-
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.
56+
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.
5757

5858
## Database Migrations
5959

docs/docusaurus.config.js

Lines changed: 59 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ const prism = require('prism-react-renderer');
66
/** @type {import('@docusaurus/types').Config} */
77
const config = {
88
title: 'Immich',
9-
tagline: 'High performance self-hosted photo and video backup solution directly from your mobile phone',
9+
tagline: 'Self-hosted photo and video management solution',
1010
url: 'https://docs.immich.app',
1111
baseUrl: '/',
1212
onBrokenLinks: 'throw',
@@ -93,35 +93,15 @@ const config = {
9393
position: 'right',
9494
},
9595
{
96-
to: '/overview/quick-start',
96+
href: 'https://immich.app/',
9797
position: 'right',
98-
label: 'Docs',
99-
},
100-
{
101-
href: 'https://immich.app/roadmap',
102-
position: 'right',
103-
label: 'Roadmap',
104-
},
105-
{
106-
href: 'https://api.immich.app/',
107-
position: 'right',
108-
label: 'API',
109-
},
110-
{
111-
href: 'https://immich.store',
112-
position: 'right',
113-
label: 'Merch',
98+
label: 'Home',
11499
},
115100
{
116101
href: 'https://github.com/immich-app/immich',
117102
label: 'GitHub',
118103
position: 'right',
119104
},
120-
{
121-
href: 'https://discord.immich.app',
122-
label: 'Discord',
123-
position: 'right',
124-
},
125105
{
126106
type: 'html',
127107
position: 'right',
@@ -134,45 +114,87 @@ const config = {
134114
style: 'light',
135115
links: [
136116
{
137-
title: 'Overview',
117+
title: 'Download',
138118
items: [
139119
{
140-
label: 'Quick start',
141-
to: '/overview/quick-start',
120+
label: 'Android',
121+
href: 'https://get.immich.app/android',
142122
},
143123
{
144-
label: 'Installation',
145-
to: '/install/requirements',
124+
label: 'iOS',
125+
href: 'https://get.immich.app/ios',
146126
},
147127
{
148-
label: 'Contributing',
149-
to: '/overview/support-the-project',
128+
label: 'Server',
129+
href: 'https://immich.app/download',
150130
},
131+
],
132+
},
133+
{
134+
title: 'Company',
135+
items: [
151136
{
152-
label: 'Privacy Policy',
153-
to: '/privacy-policy',
137+
label: 'FUTO',
138+
href: 'https://futo.tech/',
139+
},
140+
{
141+
label: 'Purchase',
142+
href: 'https://buy.immich.app/',
143+
},
144+
{
145+
label: 'Merch',
146+
href: 'https://immich.store/',
154147
},
155148
],
156149
},
157150
{
158-
title: 'Documentation',
151+
title: 'Sites',
159152
items: [
160153
{
161-
label: 'Roadmap',
162-
href: 'https://immich.app/roadmap',
154+
label: 'Home',
155+
href: 'https://immich.app',
156+
},
157+
{
158+
label: 'My Immich',
159+
href: 'https://my.immich.app/',
160+
},
161+
{
162+
label: 'Awesome Immich',
163+
href: 'https://awesome.immich.app/',
163164
},
164165
{
165-
label: 'API',
166+
label: 'Immich API',
166167
href: 'https://api.immich.app/',
167168
},
169+
{
170+
label: 'Immich Data',
171+
href: 'https://data.immich.app/',
172+
},
173+
{
174+
label: 'Immich Datasets',
175+
href: 'https://datasets.immich.app/',
176+
},
177+
],
178+
},
179+
{
180+
title: 'Miscellaneous',
181+
items: [
182+
{
183+
label: 'Roadmap',
184+
href: 'https://immich.app/roadmap',
185+
},
168186
{
169187
label: 'Cursed Knowledge',
170188
href: 'https://immich.app/cursed-knowledge',
171189
},
190+
{
191+
label: 'Privacy Policy',
192+
to: '/privacy-policy',
193+
},
172194
],
173195
},
174196
{
175-
title: 'Links',
197+
title: 'Social',
176198
items: [
177199
{
178200
label: 'GitHub',

docs/static/_redirects

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@
2323
/features/storage-template /administration/storage-template 307
2424
/features/user-management /administration/user-management 307
2525
/developer/contributing /developer/pr-checklist 307
26+
/developer/open-api /api 307
2627
/guides/machine-learning /guides/remote-machine-learning 307
2728
/administration/password-login /administration/system-settings 307
2829
/features/search /features/searching 307

0 commit comments

Comments
 (0)