1
0
mirror of https://github.com/immich-app/immich.git synced 2024-11-28 09:33:27 +02:00
Commit Graph

314 Commits

Author SHA1 Message Date
mmomjian
b4d5f14e13
Document how to prevent HTML entity escaping. (#6773)
* Update _storage-template.md

* Update _storage-template.md
2024-01-30 13:30:58 -06:00
mmomjian
417a35189d
docs: add FAQ for duplicate primary key errors (#6763)
* Update FAQ.mdx

* Update FAQ.mdx
2024-01-30 18:45:31 +00:00
Jonathan Jogenfors
f6afb23d56
docs(server): Fix glob pattern in library exclusions (#6752)
fix glob pattern in library exclusions
2024-01-30 07:57:22 -05:00
Ben McCann
a7e01bc3fe
docs: fix typo (#6739) 2024-01-29 20:57:28 -05:00
Jason Rasmussen
a162af0e70
docs: fix broken link (#6735) 2024-01-29 22:09:33 +00:00
Jason Rasmussen
6dca47c629
refactor: no experimental vm modules (#6719) 2024-01-29 09:11:02 -06:00
debricked[bot]
70aeb82c5d
fix(deps) CVE–2023–45857 (bump axios) (#6665)
* fix(deps) CVE–2023–45857

* bump axios in docs

---------

Co-authored-by: debricked[bot] <47180885+debricked[bot]@users.noreply.github.com>
Co-authored-by: Jonathan Jogenfors <jonathan@jogenfors.se>
2024-01-26 19:26:31 -05:00
Jonathan Jogenfors
78a2fa8569
fix(deps): bump lodash (#6672)
bump lodash
2024-01-26 11:39:47 -05:00
Jonathan Jogenfors
0d3929f732
fix(deps) bump marked to 11.1.1 (#6670)
bump marked to 11.1.1
2024-01-26 11:32:01 -05:00
Jonathan Jogenfors
2d0db5d0f2
fix(deps) CVE-2022-25883 (#6667)
fix CVE-2022-25883
2024-01-26 09:24:35 -06:00
debricked[bot]
33b3b8093e
fix(deps) CVE–2022–25887 (#6664)
* fix(deps) CVE–2022–25887

* bump version

---------

Co-authored-by: debricked[bot] <47180885+debricked[bot]@users.noreply.github.com>
Co-authored-by: Jonathan Jogenfors <jonathan@jogenfors.se>
2024-01-26 10:00:43 -05:00
debricked[bot]
48fd64af56
fix(deps) CVE–2021–43138 (#6662)
* Fix CVE–2021–43138

* bump async

---------

Co-authored-by: debricked[bot] <47180885+debricked[bot]@users.noreply.github.com>
Co-authored-by: Jonathan Jogenfors <jonathan@jogenfors.se>
2024-01-26 10:00:17 -05:00
debricked[bot]
741ce04e7f
Fix CVE–2023–45133 (#6661)
Co-authored-by: debricked[bot] <47180885+debricked[bot]@users.noreply.github.com>
2024-01-26 07:54:12 -06:00
aviv926
19d4c5e9f7
docs: Update documentation (#6430)
* Documentation corrections

* fix import

* add firewall note

* npm run format:fix

* fixs

* npm run format:fix

* space

* fix note

* admin-jobs.png image update + fixes

* Storage Template.md update

* Add new Troubleshooting about symbolic link in library

* Updating the libraries.md

* Updating the libraries.md

* Corrections

* add `/`

* ...

* Add Python script to remove-offline-files.md

* npm run format:fix

* Add info about HDR in FAQ

* My wrong merge

* add info about symlink

* [Community] + PowerShell

* add 360 photo support to Features in README

* add info about remote ML and info about orphaned files from the external library to the scripts page

* Typo

* add note about storage locations

* add info about Purge for portainer and link to info about asset types and storage locations

* npm run format:fix

* Add FAQ about "faces" that aren't faces

* Update docs/docs/administration/backup-and-restore.md

* Update docs/docs/administration/backup-and-restore.md

---------

Co-authored-by: Jason Rasmussen <jrasm91@gmail.com>
2024-01-25 17:17:38 +00:00
Jason Rasmussen
852effa998
refactor(server): e2e (#6632) 2024-01-24 17:24:53 -05:00
Lenart Kos
5f051e3104
docs: add reverse proxy configuration for Apache (#6625) 2024-01-24 10:11:36 -05:00
Jason Rasmussen
d801131f38
fix(docs): search (#6605) 2024-01-23 17:50:25 -05:00
Jason Rasmussen
61bb52ac11
docs: diff highlighting (#6604) 2024-01-23 18:51:02 +00:00
sybenx
4fa7005a24
spelling of "recommend" - Update command-line-interface.md (#6603) 2024-01-23 17:09:32 +00:00
Jason Rasmussen
42d208859e
fix(web): auto generate open api build (#6561)
* fix: autogen typescript-sdk/build

* chore: refactor script
2024-01-22 09:59:35 -06:00
Jason Rasmussen
e4277128be
chore: remove unused files and references (#6562) 2024-01-21 22:57:37 -06:00
Aram Akhavan
6b419a984c
doc: developer setup docs (#6557) 2024-01-21 22:32:01 +00:00
Alex Tran
144822ddc4 chore: recap post date 2024-01-19 19:44:01 -06:00
Jason Rasmussen
df27460f1c
fix: open api pump (#6502) 2024-01-19 11:09:18 -06:00
Mert
68f52818ae
feat(server): separate face clustering job (#5598)
* separate facial clustering job

* update api

* fixed some tests

* invert clustering

* hdbscan

* update api

* remove commented code

* wip dbscan

* cleanup

removed cluster endpoint

remove commented code

* fixes

updated tests

minor fixes and formatting

fixed queuing

refinements

* scale search range based on library size

* defer non-core faces

* optimizations

removed unused query option

* assign faces individually for correctness

fixed unit tests

remove unused method

* don't select face embedding

update sql

linting

fixed ml typing

* updated job mock

* paginate people query

* select face embeddings because typeorm

* fix setting face detection concurrency

* update sql

formatting

linting

* simplify logic

remove unused imports

* more specific delete signature

* more accurate typing for face stubs

* add migration

formatting

* chore: better typing

* don't select embedding by default

remove unused import

* updated sql

* use normal try/catch

* stricter concurrency typing and enforcement

* update api

* update job concurrency panel to show disabled queues

formatting

* check jobId in queueAll

fix tests

* remove outdated comment

* better facial recognition icon

* wording

wording

formatting

* fixed tests

* fix

* formatting & sql

* try to fix sql check

* more detailed description

* update sql

* formatting

* wording

* update `minFaces` description

---------

Co-authored-by: Jason Rasmussen <jrasm91@gmail.com>
Co-authored-by: Alex Tran <alex.tran1502@gmail.com>
2024-01-18 00:08:48 -05:00
Jason Rasmussen
44873b4224
deps: update docs (#6462) 2024-01-17 22:44:45 -05:00
Jason Rasmussen
98cee8864d
docs: remove tsc check (#6464) 2024-01-17 22:37:48 -05:00
Steven Carter
d4146e3e6d
feat(server): provide the ability to search archived photos (#6332)
* Feat: provide the ability to search archived photos

Adds a query parameter (`searchArchived`) to the search URL parameters
to allow the results to contain archived photos.

* chore: rename includeArchived => withArchived

* chore: open api

---------

Co-authored-by: Jason Rasmussen <jrasm91@gmail.com>
2024-01-18 02:08:00 +00:00
Hiren Shah
a7768cc64d
docs: Update remove-offline-files.md (#6449)
The previous Windows Powershell script didn't work - resulted in a bunch of errors due to multiple reasons.  The revised code works as expected.
2024-01-17 11:40:33 -05:00
renovate[bot]
9300946ff1
fix(deps): update docs (#6420)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2024-01-16 09:27:04 -05:00
Jason Rasmussen
3e793c582e
docs: fix pgadmin links (#6403) 2024-01-15 17:19:41 +00:00
Guillermo
f3d9196a7e
fix(docs) Fix command name (#6368) 2024-01-13 14:16:17 -06:00
Thariq Shanavas
9a7f987835
fix(docs) Fix relative paths leading to broken links (#6354) 2024-01-13 14:15:32 -06:00
aviv926
df4af025d7
Edit and update of FAQ+new database GUI guide (#5958)
* Update added and re -arrangement of FAQ

* Erasure of addition mistakes

* Erasure of addition mistakes

* Fix broken links

* Correcting spelling errors + adding more questions

* New required fixes

* More FAQ

* Adding questions + adding a note about a directory and an explanation about adding a path in a Windows environment

* Update docs/docs/FAQ/Albums-FAQ.md

Co-authored-by: Mert <101130780+mertalev@users.noreply.github.com>

* Update docs/docs/FAQ/Assets-FAQ.md

Co-authored-by: Mert <101130780+mertalev@users.noreply.github.com>

* Update docs/docs/FAQ/Machine-Learning-FAQ.md

Co-authored-by: Mert <101130780+mertalev@users.noreply.github.com>

* Update docs/docs/FAQ/Machine-Learning-FAQ.md

Co-authored-by: Mert <101130780+mertalev@users.noreply.github.com>

* Update docs/docs/features/libraries.md

Co-authored-by: Mert <101130780+mertalev@users.noreply.github.com>

* Corrections

* chore: updates

* import TOCinlines from all FAQ pages to one page + Corrections

* Removing privacy information + adding required Flutter version information

* Removing privacy information + adding required Flutter version information

* Revert "Removing privacy information + adding required Flutter version information"

This reverts commit da63439fd2.

* All in one page

* Guide - Remove Offline Files

* Guide - Remove Offline Files

* doc: updates

* chore: fix broken link

* docs: clean up database gui guide

---------

Co-authored-by: Alex <alex.tran1502@gmail.com>
Co-authored-by: Mert <101130780+mertalev@users.noreply.github.com>
Co-authored-by: Jason Rasmussen <jrasm91@gmail.com>
2024-01-12 14:45:41 -05:00
Jason Rasmussen
2439c5ab57
refactor: open api (#6334) 2024-01-12 07:36:27 -05:00
Graham Steffaniak
a1523a9af0
docs: Update libraries.md (#6333) 2024-01-11 17:10:48 -05:00
Jason Rasmussen
bf1dd36fa9
refactor(server): split api and jobs into separate e2e suites (#6307)
* refactor: domain and infra modules

* refactor(server): e2e tests
2024-01-09 23:04:16 -05:00
renovate[bot]
26e6602ed3
fix(deps): update docs (#6284)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2024-01-09 16:48:32 -05:00
bo0tzz
58bd9c0018
fix(docs): Use absolute path for external library guide (#6290)
* fix(docs): Use absolute path for external library guide

* fix: Cursor in screenshot
2024-01-09 09:32:30 -06:00
Thariq Shanavas
ad09896f58
feat(docs): Template script for 3-2-1 backup of the assets and database (#6026)
* Added borg template cron job

* moved script to guides section

* Mentioned db backup location in docs

* Added directions for restoring backups
2024-01-05 15:02:55 -06:00
bo0tzz
ac0cb4a96e
Revert "docs: add step by step set up guide for external libraries (#5288)" (#6194)
This reverts commit 27be076958.
2024-01-05 09:45:50 -06:00
martin
aefd93e43a
feat(server): add env for reverse geocoding path (#6163)
* feat: add env for reverse geocoding path

* fix: quote in doc
2024-01-04 13:36:52 +00:00
Jason Rasmussen
f8d64be13c
feat(server)!: move welcome message to settings (#6157)
* feat(server): move welcome message to settings

* chore: open api
2024-01-04 05:00:17 +00:00
Jason Rasmussen
52e92e9bb4
docs: unused geocoding env variable (#6158) 2024-01-04 04:56:18 +00:00
renovate[bot]
103c3ee2f1
fix(deps): update docs (#6120)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2024-01-03 16:55:59 -05:00
Colin
40fbe81c7b
docs: typo detial -> detail (#6135)
Also added missing "."
2024-01-03 03:34:42 +00:00
jcianci12
27be076958
docs: add step by step set up guide for external libraries (#5288)
* Update libraries.md - External Library step by step set up guide added

When setting up immmich external libraries, I found some missing details around the relationship between external paths and import paths. By providing an example, I am hoping it helps new users.

* chore: fix formatting

---------

Co-authored-by: Jason Rasmussen <jrasm91@gmail.com>
2024-01-01 22:18:28 -05:00
Davis Clark
2688e05033
docs: update hardware-transcoding.md (#5968)
* Update hardware-transcoding.md

I accidentally closed #5924 for some odd reason. Copied the same code changes to this one.

* updated formatting

* Update hardware-transcoding.md

Added line 66 saying that `NVIDIA_DRIVER_CAMPABILITITES` is no longer required.
2024-01-01 20:50:03 +00:00
Michael Lyon
523e7d4742
fix(docs): update broken links (#6094)
* fix(docs): update broken link

* fix(docs): change to path

* fix(docs): second broken link

---------

Co-authored-by: Jason Rasmussen <jrasm91@gmail.com>
2024-01-01 20:32:16 +00:00
dependabot[bot]
1af27fcc47
chore(deps): bump @babel/traverse from 7.23.0 to 7.23.6 in /docs (#6021)
Bumps [@babel/traverse](https://github.com/babel/babel/tree/HEAD/packages/babel-traverse) from 7.23.0 to 7.23.6.
- [Release notes](https://github.com/babel/babel/releases)
- [Changelog](https://github.com/babel/babel/blob/main/CHANGELOG.md)
- [Commits](https://github.com/babel/babel/commits/v7.23.6/packages/babel-traverse)

---
updated-dependencies:
- dependency-name: "@babel/traverse"
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2023-12-27 21:24:43 +00:00
Marios Kerasiotis
1d0dbdff67
fix(documentation): entities path in migrations (#5985) (#5986)
Changed path: server/src/infra/database/entities to server/src/infra/entities
2023-12-26 14:04:41 +00:00
Mert
092a23fd7f
feat(server,ml): remove image tagging (#5903)
* remove image tagging

* updated lock

* fixed tests, improved logging

* be nice

* fixed tests
2023-12-20 20:47:56 -05:00
Jon Howell
a7b4727c20
feat(docs): Add a linear quick-start guide (#5812)
* feat(docs): Add a linear quick-start guide

* prettier

* fix: format

* removed unused text

---------

Co-authored-by: Alex Tran <alex.tran1502@gmail.com>
2023-12-18 20:45:49 +00:00
Ferdinand Mütsch
b68800d45c
chore(docs): add caddy reverse proxy config example (#5777) 2023-12-18 02:22:59 +00:00
Alex
691e20521d
docs: update default config content (#5798) 2023-12-17 12:07:53 -06:00
Jon Howell
00771899da
fix(docs): remove inline dev inquiries (#5733)
* fix(docs): correct link; remove inline dev inquiries

* unfix relative path
2023-12-17 10:46:29 -05:00
Jon Howell
d9b5adf0f7
fix(docs): remove spurious hyphen in docker compose cmd (#5771)
The command example is correct, but the text just before it still references the old docker-compose command.
2023-12-16 19:49:14 -05:00
martin
2f95cb89c1
fix(web): use env for web folder path (#5753)
* fix: use env for web folder path

* feat: use constant

* fix: use join

* update docs

* fix: icon
2023-12-16 11:15:30 -06:00
Mert
cb1201e690
chore(web): update job dashboard (#5745)
* rename clip encoding to smart search

* update job subtitles

* update api

* update smart search job title and subtitle

* fix `getJobName`

* change smart search icon

* formatting

* wording

* update reference to clip

* formatting

* update reference to Encode CLIP
2023-12-16 10:50:46 -06:00
Jason Rasmussen
94e11d52dc
docs: fix redirects for cloudflare (#5734) 2023-12-15 15:20:50 -06:00
Jon Howell
05a1283500
fix(docs): Add title for External Library guide (#5732) 2023-12-15 14:38:14 -05:00
Jon Howell
899c71f297
docs: add a walk-through guide for External Libraries (#5594)
* Add a walk-through guide for External Libraries

* Apply prettier to markdown

* Add screenshots for GUI elements

* fix format
2023-12-15 12:46:43 -06:00
martin
2aa5f55cbf
docs: update milestone page (#5663) 2023-12-15 09:50:13 -06:00
bo0tzz
e29b80845b
chore: Update docs url config (#5716) 2023-12-15 08:57:36 -06:00
Jason Rasmussen
9bb6befc92
docs: clean-up old references (#5697)
* docs: clean-up old references

* chore: fix ref
2023-12-14 09:53:08 -05:00
Slavik
679b22fada
docs: remove citiesFileOverride from config-file.md; fixes #5682 (#5683)
as a result of PR #5301, the citiesFileOverride  variable is not used anymore.
2023-12-13 14:54:51 -05:00
Alex
f7429c3615
docs: recap 2023 (#5665)
* docs: recap 2023

* fix: format
2023-12-13 03:03:15 +00:00
Jason Rasmussen
a0b2cbe123
feat: update arch diagram (#5662)
* feat: update arch diagram

* chore: alt test
2023-12-12 16:16:39 -06:00
bo0tzz
05550647eb
docs: FAQ for thumbnail jobs (#5661) 2023-12-12 22:39:56 +01:00
Alex Tran
c8da1c07dc chore: add _redirects to docs for CloudFlare 2023-12-11 16:13:39 -06:00
pjsxw
f798e9beed
docs: update backup-and-restore.md (#5616)
Removes `BACKUP_KEEP_NUM` option from docker-compose example for database dumping, since it no longer exists in the linked image. 

The image has sensible defaults for backups to keep (7 daily, 4 weekly, 6 monthly), so I haven't replaced the argument with an alternative.
2023-12-11 10:57:30 -06:00
Mert
8057c375ba
docs: remove typesense from faq (#5600) 2023-12-10 03:23:40 +00:00
Jason Rasmussen
8e07b35786
docs: add sponsor link (#5597) 2023-12-09 20:59:00 -06:00
Jon Howell
188cdf9367
docs: Add tip showing common error messages (#5592)
I encountered two errors trying to use Ubuntu-distributed docker. These tips make the error messages searchable, with a pointer to the solution (use docker's packages).
2023-12-10 01:05:58 +00:00
Jason Rasmussen
1e99ba8167
feat: use pgvecto.rs (#3605) 2023-12-08 11:15:46 -05:00
Daniel Dietzler
6000c7f3bc
update docs to use docker compose (#5446) 2023-12-02 12:48:49 +01:00
renovate[bot]
0fe704c6f9
fix(deps): update dependency clsx to v2 (#5383)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2023-11-29 04:07:05 +00:00
renovate[bot]
869d400617
chore(deps): update dependency prettier to v3 (#5371)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2023-11-29 02:30:53 +00:00
Jason Rasmussen
6ae7a92e03
fix(docs): build (#5374) 2023-11-29 02:27:01 +00:00
Thariq Shanavas
b21b7f0721
chore(docs): add guide on remote access (#5350)
* Added guide on remote access

* update reverse proxy section

* chore: formatting

---------

Co-authored-by: Jason Rasmussen <jrasm91@gmail.com>
2023-11-29 00:49:36 +00:00
Daniel Dietzler
cffdd9c86a
web and proxy no more! (#5347) 2023-11-27 22:59:40 +00:00
Aamir Azad
6eadca330b
docs: change github sponsor link to organization (#5267) 2023-11-22 18:17:56 +00:00
renovate[bot]
55f7cf3ca9
chore(deps): update dependency typescript to v5.3.2 (#5236)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2023-11-21 13:48:31 -05:00
bo0tzz
bcb885422a
feat(docs): Add no-ssr milestone (#5220)
* Add no-ssr milestone

* chore: formatting

* feat: activity

---------

Co-authored-by: martabal <74269598+martabal@users.noreply.github.com>
2023-11-21 08:50:56 -06:00
Alex
74ad8b37bb
docs: update requirement for CLI (#5198) 2023-11-20 19:54:46 +00:00
bo0tzz
f20a6cb321
chore(docs): Redirect old CLI paths (#5183)
* chore(docs): Redirect old CLI paths

* Update docs/vercel.json

Co-authored-by: Jason Rasmussen <jrasm91@gmail.com>

---------

Co-authored-by: Jason Rasmussen <jrasm91@gmail.com>
2023-11-20 13:20:58 +00:00
Jonathan Jogenfors
7e38e7c949
feat(cli): refactor and add album support (#4434)
* Allow building and installing cli

* feat: add format fix

* docs: remove cli folder

* feat: use immich scoped package

* feat: rewrite cli readme

* docs: add info on running without building

* cleanup

* chore: remove import functionality from cli

* feat: add logout to cli

* docs: add todo for file format from server

* docs: add compilation step to cli

* fix: success message spacing

* feat: can create albums

* fix: add check step to cli

* fix: typos

* feat: pull file formats from server

* chore: use crawl service from server

* chore: fix lint

* docs: add cli documentation

* chore: rename ignore pattern

* chore: add version number to cli

* feat: use sdk

* fix: cleanup

* feat: album name on windows

* chore: remove skipped asset field

* feat: add more info to server-info command

* chore: cleanup

* chore: remove unneeded packages

* chore: fix docs links

* feat: add cli v2 milestone

* fix: set correct cli date

---------

Co-authored-by: Alex <alex.tran1502@gmail.com>
2023-11-19 22:16:24 +00:00
digitaljamie
88b5f5b500
chore(docs): Update machine-learning.md 2023-11-19 18:47:42 +00:00
shenlong
41d43acf5f
mobile: add initial DCM analysis_options (#5136)
Co-authored-by: shalong-tanwen <139912620+shalong-tanwen@users.noreply.github.com>
2023-11-18 23:17:08 -06:00
Jason Rasmussen
adae5dd758
feat(web)!: SPA (#5069)
* feat(web): SPA

* chore: remove unnecessary prune

* feat(web): merge with immich-server

* Correct method name

* fix: bugs, docs, workflows, etc.

* chore: keep dockerignore for dev

* chore: remove license

* fix: expose 2283

---------

Co-authored-by: Alex Tran <alex.tran1502@gmail.com>
2023-11-17 22:13:36 -06:00
Mert
a6af4892e3
fix(ml): better model unloading (#3340)
* restart process on inactivity

* formatting

* always update `last_called`

* load models sequentially

* renamed variable, updated docs

* formatting

* made poll env name consistent with model ttl env
2023-11-16 20:42:44 -06:00
renovate[bot]
66120025b7
fix(deps): update dependency tailwindcss to v3.3.5 (#4980)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2023-11-12 10:04:24 -05:00
Ploonet
98f1e85c87
fix(docs): Typo in libraries exclusion pattern (#4972)
Co-authored-by: Antony Mota <amota.confluenceconseil@boiron.fr>
2023-11-12 09:49:47 -05:00
Brian Austin
7fca0d8da5
fix: replace first and last name with single field (#4915) 2023-11-11 19:03:32 -06:00
Sushain Cherivirala
986bbfa831
feat(server): don't re-run face recognition on assets without any faces (#4854)
* Add AssetJobStatus

* fentity

* Add jobStatus field to AssetEntity

* Fix the migration doc paths

* Filter on facesRecognizedAt

* Set facesRecognizedAt field

* Test for facesRecognizedAt

* Done testing

* Adjust FK properties

* Add tests for WithoutProperty.FACES

* chore: non-nullable

---------

Co-authored-by: Jason Rasmussen <jrasm91@gmail.com>
2023-11-09 20:55:00 -05:00
Alex
bb28cae671
docs: update (#4893)
* docs: update

* chore:format
2023-11-07 15:52:44 -06:00
Jason Rasmussen
f6180fccdc
chore(server): compose updates (#4878)
* chore: compose updates

* chore: docs for troubleshooting

* chore: add reference in docker compose to docs
2023-11-07 11:34:03 -05:00
Jason Rasmussen
c74ea7282a
docs: python upload guide (#4867) 2023-11-06 09:08:36 -05:00
Jesbin
330f4cadda
docs: changes to docker compose command. (#4828) 2023-11-03 16:01:17 -05:00
Alex
d8903de92e
docs: remove read-only related content (#4781)
* docs: remove read-only related content

* format

* broken link
2023-11-01 20:49:57 -05:00