Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cleaning up documentation: bye bye Livewire #166

Merged
merged 3 commits into from
Dec 14, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,11 @@ For non-core options (for example UI options), take a look at [Settings](https:/
| `TIMEZONE` | The timezone of your photos., requires a named timezone identifier like `Europe/Paris` | system timezone of server |
| `LYCHEE_UPLOADS` | Path to uploads directory | `uploads/` inside `public/` |
| `LYCHEE_UPLOADS_URL` | URL to uploads directory, better left empty | `/uploads` |
| `APP_FORCE_HTTPS` | Force HTTPS on all URLs | `false` |
| `TRUSTED_PROXIES` | Trusted proxy IP addresses | `null` |
| `LOG_VIEWER_ENABLED` | Enable log viewer inside Lychee instead of through CLI. | `true` |
| `LIVEWIRE_ENABLED` | Enable v5 Livewire frontend; set to `false` if the new frontend doesn't work on our installation (this is a **temporary** workaround). | `true` |

| `VUEJS_ENABLED` | Enable v6 VueJs frontend; set to `false` if the new frontend doesn't work on our installation (this is a **temporary** workaround). | `true` |
| `LEGACY_API_ENABLED` | Enable the Legacy API, it will be enabled if `VUEJS_ENABLED` is set to `false`. | `false` |
ildyria marked this conversation as resolved.
Show resolved Hide resolved

> {note} `APP_URL` must only contain the hostname up to the Top Level Domain (tld) _e.g._ .com, .org etc.
> If you are using Lychee in a sub folder, specify the path after the tld here in the `APP_DIR` constant.
Expand Down
159 changes: 0 additions & 159 deletions docs/livewire.md

This file was deleted.

36 changes: 0 additions & 36 deletions docs/org.md

This file was deleted.

13 changes: 8 additions & 5 deletions docs/structure.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,13 @@ The `resources` directory contains your views as well as the TypeScript and CSS

### The Routes Directory
The `routes` directory contains all of the route definitions for Lychee. Several route files are included with Lychee:
`api.php`, `web-admin.php`, `web-install.php`, `web-livewire.php`, and `web.php`.
`api-v1.php`, `api-v2.php`, `web-admin-v1.php`, `web-admin-v2.php`, `web-install.php`, `web-v1.php`, and `web-v2.php`.

This makes the separation between the two REST API:
- `v1` routes are used by legacy endpoints, i.e. version 4 of Lychee. This is mostly used as POST requests.
- `v2` routes are used by the Version 6 front-end with VueJs. It makes use of a more proper REST definition with PATCH, POST, GET and DELETE.

By default `v1` routes are disabled since version 6.

### The Storage Directory
The `storage` directory contains your compiled Blade templates, file based sessions, file caches, and other files generated by the framework. This directory is segregated into `app`, `framework`, and `logs` directories. The `app` directory may be used to store any files generated by your application. The `framework` directory is used to store framework generated files and caches. Finally, the `logs` directory contains Laravel's log files (useful in case of hard crash).
Expand All @@ -53,7 +59,7 @@ The `vendor` directory contains your [Composer][2] dependencies.
## The App Directory
The majority of Lychee is housed in the `app` directory. By default, this directory is namespaced under `App` and is autoloaded by Composer using the [PSR-4 autoloading standard][3].

The `app` directory contains a variety of additional directories such as `Console`, `Http`, `Livewire` and `Providers`. Think of the `Console`, `Livewire`, and `Http` directories as providing an API into the core of your application. The HTTP protocol and CLI are both mechanisms to interact with Lychee, but do not actually contain application logic. In other words, they are two ways of issuing commands to Lychee. The `Console` directory contains all of the Artisan commands, while the `Http` directory contains your controllers, middleware, and requests. Furthermore the `Livewire` directory contains the serverside code necessary for the new front-end.
The `app` directory contains a variety of additional directories such as `Console`, `Http`, and `Providers`. Think of the `Console` and `Http` directories as providing an API into the core of your application. The HTTP protocol and CLI are both mechanisms to interact with Lychee, but do not actually contain application logic. In other words, they are two ways of issuing commands to Lychee. The `Console` directory contains all of the Artisan commands, while the `Http` directory contains your controllers, middleware, and requests.

### The Console Directory
The `Console` directory contains all of the custom Artisan commands for Lychee. These commands may be generated using the `make:command` command.
Expand Down Expand Up @@ -81,9 +87,6 @@ The `Image` directory contains our image handler. We provide here two ways to ma
- with GD,
- with imagick.

### The Livewire Directory
The `Livewire` directory contains the server-side logic for the Livewire front-end. See more [here](livewire.html)

### The Metadata Directory
The `Metatdata` directory contains logic related to data such as Exif information, geodecoding, lychee version, GitHub monitoring...

Expand Down
6 changes: 2 additions & 4 deletions gen.py
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,6 @@ def generate_base():

pages_title = {}

pages_title['org'] = 'Lychee & LycheeOrg'
pages_title['releases'] = 'Release Notes'

pages_title['installation'] = 'Installation'
Expand All @@ -66,18 +65,17 @@ def generate_base():
pages_title['architecture'] = 'Lychee logic overview'
pages_title['structure'] = 'Directory Structure'
pages_title['frontend'] = 'Front-end'
pages_title['livewire'] = 'Livewire Front-end (alpha)'

structure = [['Prologue',
['org', 'releases']]]
['releases']]]
structure += [['Getting Started',
['installation', 'configuration', 'docker', 'update', 'upgrade']]]
structure += [['Advanced Topics',
['settings', 'keyboard', 'advanced-setups', 'honeypot', 'external_tracking']]]
structure += [['Frequently Asked Question',
['faq_general', 'faq_installation', 'faq_troubleshooting']]]
structure += [['Contributing',
['contributions', 'api', 'architecture', 'structure', 'frontend', 'livewire']]]
['contributions', 'api', 'architecture', 'structure', 'frontend']]]


def gen_github_link(page):
Expand Down