Documentation updates #8

2025-04-28T11:43:46Z

64-RD commented

2025-04-28 11:43:46 +00:00

(Migrated from github.com)

expanded Docker article to include full example configuration
cleaned up code snippets to only include parts instead of full configurations
few small fixes and adjustments

Been a while since I touched GitHub or modified someone's else documentation, hope everything's in order

- expanded Docker article to include full example configuration - cleaned up code snippets to only include parts instead of full configurations - few small fixes and adjustments Been a while since I touched GitHub or modified someone's else documentation, hope everything's in order

williamhorning (Migrated from github.com) reviewed

2025-04-29 11:12:53 +00:00

williamhorning (Migrated from github.com) left a comment

this all looks really good so far but i do have a few little questions

src/content/docs/lightning/hosting/database.md

					
				@ -16,3 +16,1 @@

				```toml {3-7}

				prefix = "!"

				```toml

just a general note: for sections like this with the brackets and line numbers, this makes astro highlight specific portions of the example config and reflects what the original vitepress site did (but it instead blurred the rest of the snippet).

is this unclear to people? would finding a way to blur the non-highlighted lines be more clear about the original intent here?

just a general note: for sections like this with the brackets and line numbers, this makes astro highlight specific portions of the example config and reflects what the original vitepress site did (but it instead blurred the rest of the snippet). is this unclear to people? would finding a way to blur the non-highlighted lines be more clear about the original intent here?

src/content/docs/lightning/hosting/database.md

would adding the official docs on connection strings in addition to the stackoverflow link be clear? while im not against linking to stackoverflow, but maybe it's worth linking to both?

would adding the [official docs on connection strings](https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNSTRING-URIS) in addition to the stackoverflow link be clear? while im not against linking to stackoverflow, but maybe it's worth linking to both?

src/content/docs/lightning/hosting/database.md

fwiw i did remove mongodb support at some point though i do plan on adding it back eventually

src/content/docs/lightning/hosting/docker.md

					
				@ -20,2 +20,3 @@

				## Setting up the container

				In this example we will use Docker Compose to set up container for

				Lightning, and optionally, the database as well.

this reads a bit weird, at least to me, when placed after the note box. would you be fine if this was above the note box and with the initial introductory text?

src/content/docs/lightning/hosting/docker.md

					
				@ -30,0 +31,4 @@

				  lightning:

				    image: ghcr.io/williamhorning/lightning:latest

				    volumes:

				      - ./config:/data

specifying a version explicitly is generally something i'd prefer here, so it might be worth replacing latest with 0.8.0-alpha.2 (or whatever the latest version is)

src/content/docs/lightning/hosting/docker.md

					
				@ -39,0 +51,4 @@

				plugin = "jsr:@lightning/discord@0.8.0-alpha.1"

				config.token = "YOUR_DISCORD_BOT_TOKEN"

				[[plugins]]

note to self: use this same formatting for other secrets elsewhere

src/content/docs/lightning/hosting/docker.md

					
				@ -39,0 +61,4 @@

				and Revolt, however you can customize it however you want - see [_configuration_](../configuration)

				and [_plugins_](../plugins).

note to self: check relative links

src/content/docs/lightning/hosting/docker.md

					
				@ -39,0 +84,4 @@

				       - '5432:5432'

				    environment:

				      POSTGRES_HOST_AUTH_METHOD: trust

				```

it may be worth mounting the docker volume somewhere here, at least to show that it's something that you can do

src/content/docs/lightning/hosting/docker.md

					
				@ -39,0 +100,4 @@

				## Running the container(s)

				Use `docker compose up -d` to run our container(s).

Because you are hosting your database in a container instead of locally, in `lightning.toml`
you need to replace `localhost` with `db`.

docker allows you to use the container name as its hostname and this tends to just work (from my experience) and is more descriptive (at least imo) than a magic ip

```suggestion Because you are hosting your database in a container instead of locally, in `lightning.toml` you need to replace `localhost` with `db`. ``` docker allows you to use the container name as its hostname and this tends to just work (from my experience) and is more descriptive (at least imo) than a magic ip

src/content/docs/lightning/hosting/docker.md

					
				@ -39,0 +107,4 @@

				```batch

				@echo off

				docker compose up -d

				pause

note to self: add example of this?

src/content/docs/lightning/hosting/docker.md

im not sure running under windows is something i'd expect to work, but if it does, would it make sense to also include an example using powershell?

64-RD commented

2025-04-29 15:54:00 +00:00

(Migrated from github.com)

Thanks for your input! I'm a bit busy this week, but I will take care of that when I get the chance. Cheers

This pull request has changes conflicting with the target branch.

src/content/docs/lightning/hosting/configuration.md
src/content/docs/lightning/hosting/database.md
src/content/docs/lightning/hosting/docker.md
src/content/docs/lightning/hosting/plugins.md

View command line instructions

Checkout

From your project repository, check out a new branch and test the changes.

git fetch -u origin 64-RD/main:64-RD/main

git switch 64-RD/main

Merge

Merge the changes and update on Forgejo.

Warning: The "Autodetect manual merge" setting is not enabled for this repository, you will have to mark this pull request as manually merged afterwards.

git switch main

git merge --no-ff 64-RD/main

git switch 64-RD/main

git rebase main

git switch main

git merge --ff-only 64-RD/main

git switch 64-RD/main

git rebase main

git switch main

git merge --no-ff 64-RD/main

git switch main

git merge --squash 64-RD/main