Skip to content

Rewrite configuration page#4

Merged
alxlion merged 3 commits intoClaperCo:mainfrom
raulrpearson:rewrite-configuration-page
Jan 22, 2026
Merged

Rewrite configuration page#4
alxlion merged 3 commits intoClaperCo:mainfrom
raulrpearson:rewrite-configuration-page

Conversation

@raulrpearson
Copy link
Copy Markdown
Contributor

This PR rewrites the configuration page with the goal of making it more comprehensive, digestible and structured:

  • The main additions match the latest changes in the code base for the S3 config (Fix custom S3 endpoint config Claper#199) and the SMTP one (Improve SMTP config Claper#197).
  • Some missing variables are added too (e.g. LISTEN_IP, CONFIG_DIR, etc.).
  • Variables are grouped topically and split into tables interspersed with paragraph explanations where necessary.
  • The right-hand side table of contents is customized to include headings h2, h3 and h4.
  • I updated VitePress to the latest 1.x.x to add support for the dotenv code 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.

raulrpearson and others added 3 commits January 13, 2026 18:48
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.
@alxlion alxlion merged commit ebee987 into ClaperCo:main Jan 22, 2026
@raulrpearson raulrpearson deleted the rewrite-configuration-page branch January 28, 2026 14:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants