Skip to content

Commit da608b3

Browse files
committed
update docs
1 parent 351fa58 commit da608b3

5 files changed

Lines changed: 10 additions & 182 deletions

File tree

docs/contributions.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,10 @@ If you discover a security vulnerability within Lychee, please contact us direct
2727

2828
You may propose new features or improvements to existing Lychee behavior in the [issue board][1]. If you propose a new feature, please be willing to implement at least some of the code that would be needed to complete the feature.
2929

30+
## Lychee Documentation
31+
32+
You will find a complete documentation in the original [repository](https://github.com/LycheeOrg/Lychee/tree/master/docs) under the `docs/` folder.
33+
3034
## Joining the Team
3135

3236
You would like to support Lychee and help us push it further? Join the team!

docs/frontend.md

Lines changed: 0 additions & 43 deletions
This file was deleted.

docs/structure.md

Lines changed: 0 additions & 130 deletions
This file was deleted.

docs/upgrade.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,10 @@ volumes:
4242
4343
> {note} Notice the key changes: uploads are now at `/app/public/uploads`, storage at `/app/storage/app`, tmp at `/app/storage/tmp`, and the `.env` file is mounted read-only.
4444

45+
The `/sym` volume has been removed as Lychee no longer uses symbolic links for storage. This was a security features that originates from version 4, but is no longer necessary as the functionability has been killed.
46+
47+
**Important:** With the 3 volumes under `/app/storage`, You may think you could simplify the configuration by specifying one single volume for `/app/storage` instead. This is incorrect. Doing so will make the app exit with the error The `/app/bootstrap/cache` directory must be present and writable.
48+
4549
### Service Architecture Changes
4650

4751
Version 7 introduces a multi-service architecture with an optional worker service for background job processing.
@@ -215,12 +219,7 @@ Key changes to your environment configuration:
215219
docker-compose up -d
216220
```
217221

218-
#### 7. **Run Migrations**
219-
```bash
220-
docker exec lychee php artisan migrate
221-
```
222-
223-
#### 8. **Verify Installation**
222+
#### 7. **Verify Installation**
224223

225224
Check that all services are running:
226225
```bash

gen.py

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -63,8 +63,6 @@ def generate_base():
6363
pages_title['contributions'] = 'Contribution Guide'
6464
pages_title['api'] = 'API Documentation'
6565
pages_title['architecture'] = 'Lychee logic overview'
66-
pages_title['structure'] = 'Directory Structure'
67-
pages_title['frontend'] = 'Front-end'
6866

6967
structure = [['Prologue',
7068
['releases']]]
@@ -75,7 +73,7 @@ def generate_base():
7573
structure += [['Frequently Asked Question',
7674
['faq_general', 'faq_installation', 'faq_troubleshooting']]]
7775
structure += [['Contributing',
78-
['contributions', 'api', 'architecture', 'structure', 'frontend']]]
76+
['contributions', 'api', 'architecture']]]
7977

8078

8179
def gen_github_link(page):

0 commit comments

Comments
 (0)