Rewrite configuration page #4
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The S3 and SMTP sections needed updating, but I also noticed some other configuration variables missing and decided to restructure the document to make it easier to understand and reference.
It's possibly about time, should include no breaking changes and the version we had didn't highlight the `dotenv` code blocks correctly.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR rewrites the configuration page with the goal of making it more comprehensive, digestible and structured:
LISTEN_IP,CONFIG_DIR, etc.).h2,h3andh4.dotenvcode blocks. I did a quick skim of every page and nothing seems to break.It's true that tables are a bit cumbersome to edit (although my Nvim setup auto-formats them on save and they display fine if I disable wrapping), but I think that having variables displayed in this manner improves information density and regularity, making it easier to parse visually by users. Markdoc has a much better table syntax, but maybe we can consider that in the future.