doc updates

[CodeWithCJ]

Tip

Help us review and merge your PR faster!
Please ensure you have completed the Checklist below.
For Frontend changes, please run pnpm run validate to check for any errors.
PRs that include tests and clear screenshots are highly preferred!

Description

Provide a brief summary of your changes.

Related Issue

PR type [ ] Issue [ ] New Feature [x] Documentation
Linked Issue: #

Checklist

Please check all that apply:

• [MANDATORY for new feature] Alignment: I have raised a GitHub issue and it was reviewed/approved by maintainers
• Tests: I have included automated tests for my changes.
• [MANDATORY for UI changes] Screenshots: I have attached "Before" vs "After" screenshots below.
• [MANDATORY for Frontend changes] Quality: I have run pnpm run validate (especially for Frontend).
• Translations: I have only updated the English (en) translation file (if applicable).
• Architecture: My code follows the existing architecture standards.
• Database Security: I have updated rls_policies.sql for any new user-specific tables.
• [MANDATORY - ALL] Integrity & License: I certify this is my own work, free of malicious code(phishing, malware, etc.) and I agree to the License terms.

Screenshots (if applicable)

Before

[Insert screenshot/GIF here]

After

[Insert screenshot/GIF here]

[gemini-code-assist]

Summary of Changes

Hello, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request focuses on refining and expanding the project's documentation. The changes aim to provide clearer instructions and better context for users, particularly concerning environment variable setup for Docker Compose, OIDC authentication configuration, and general documentation accuracy. The updates improve the overall user experience by making essential information more accessible and understandable.

Highlights

• Documentation Disclaimer Added: A prominent disclaimer has been added to the main documentation page, informing users about potential outdated sections and directing them to GitHub Discussions and Discord for support.
• Environment Variable Documentation Enhanced: The environment variables documentation has been significantly improved with a new warning for Docker Compose users regarding variable passing, better categorization of optional variables, and clearer descriptions for encryption keys, authentication secrets, and database port configuration.
• OIDC Authentication Guide Updated: The OIDC authentication documentation now includes 'Scope' as a mandatory setting, provides more precise guidance for configuring the 'Redirect URI', and clarifies that advanced OIDC settings are tested with default values, advising caution with customization.

Changelog

• docs/content/0.index.md
  • Added a disclaimer box at the top of the documentation.
  • Included links to GitHub Discussions and Discord community for support.
• docs/content/1.install/6.environment-variables.md
  • Added a warning about Docker Compose environment variable handling.
  • Categorized optional environment variables into distinct sections (Server Side, Email, Rate Limiting, OIDC, Garmin).
  • Updated descriptions for SPARKY_FITNESS_DB_PASSWORD, SPARKY_FITNESS_API_ENCRYPTION_KEY, and BETTER_AUTH_SECRET with generation examples.
  • Clarified SPARKY_FITNESS_DB_PORT behavior for external databases and Docker Compose.
  • Moved ALLOW_PRIVATE_NETWORK_CORS and SPARKY_FITNESS_EXTRA_TRUSTED_ORIGINS to the Server Side Variables section.
• docs/content/3.administration/1.oauth-authentication.md
  • Added Scope to the list of mandatory OIDC settings.
  • Revised instructions for Redirect URI to recommend using the value from the admin interface.
  • Updated the 'Advanced Settings' section to note that customization is untested and may not work properly.
  • Converted list items from asterisks to hyphens in 'Advanced Settings' and 'Troubleshooting' sections.

Activity

• The pull request description includes a checklist for the author to ensure quality and completeness, indicating standard project procedures.
• No human activity (comments, reviews) has been recorded on this pull request yet.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request provides several documentation updates, which mostly improve clarity and organization. I've identified a few areas for improvement, including markdown syntax errors, typos, duplicated content, and sections where the descriptions could be clearer. My specific comments offer suggestions to address these points.

_{Note: Security Review has been skipped due to the limited scope of the PR.}

[gemini-code-assist]

These two variables, ALLOW_PRIVATE_NETWORK_CORS and SPARKY_FITNESS_EXTRA_TRUSTED_ORIGINS, are duplicated. They are already defined under 'Server Side Variables' (lines 55-56). To avoid confusion, please remove them from this section.

[gemini-code-assist]

The previous version of this documentation included helpful troubleshooting advice for these settings, which has been removed. This information was valuable for users. Please consider re-adding it.

Suggested change

	- **ID Token Signed Response Algorithm**: The algorithm used to sign the ID Token (e.g., `RS256`, `ES256`).
	- **Userinfo Signed Response Algorithm**: The algorithm used to sign the UserInfo response.
	- **ID Token Signed Response Algorithm**: The algorithm used to sign the ID Token (e.g., `RS256`, `ES256`). If you are facing "invalid signature" or "algorithm mismatch" errors, this is a setting to check.
	- **Userinfo Signed Response Algorithm**: The algorithm used to sign the UserInfo response. Some providers may require this to be set to a specific value, or `none` if the UserInfo response is not signed.