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

docs: clean up environment variables formatting & grammar #16555

Merged
merged 1 commit into from
Mar 4, 2025

Conversation

kofi-bhr
Copy link
Contributor

@kofi-bhr kofi-bhr commented Mar 3, 2025

I noticed a bunch of inconsistencies in the capitalization and some minor grammar issues while browsing through the environment variables docs. Nothing that would break anything, but it was bugging me enough to fix it on a Monday afternoon :)

The changes are pretty straightforward:

  • Standardized capitalization for things like "host", "port", "username" - little details that make the docs look more professional
  • Fixed a few grammar issues like "it only need to be set" → "it only needs to be set"
  • Removed that duplicate "use" in "to use use a Docker secret"
  • Made the formatting more consistent with things like "comma-separated" and "CPU"

These are the kinds of small polish items that individually don't matter much, but collectively make documentation feel more professional and easier to read. Just my small contribution to help out - figured it was a decent way to spend 15 minutes while waiting for my build to finish on another project.

…g through the docs and noticed some inconsistent capitalization and minor grammar issues. Fixed them up while having my Monday coffee :) Nothing major, but makes the docs a bit more polished.
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Mar 3, 2025
@etnoy etnoy changed the title docs: clean up environment variables formatting & grammar - Just going through the docs and noticed some inconsistent capitalization and minor grammar issues. Fixed them up while having my Monday coffee :) Nothing major, but makes the docs a bit more polished. docs: clean up environment variables formatting & grammar Mar 3, 2025
Copy link
Contributor

@etnoy etnoy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice, thanks

@alextran1502 alextran1502 enabled auto-merge (squash) March 4, 2025 04:57
@alextran1502 alextran1502 merged commit 6398489 into immich-app:main Mar 4, 2025
43 of 44 checks passed
Copy link
Contributor

github-actions bot commented Mar 4, 2025

📖 Documentation deployed to pr-16555.preview.immich.app

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog:documentation documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants