Configuration FILE has no underscore

[Rycochet]

Remove the underscore from the example for the FILE options

Summary by CodeRabbit

• Documentation
  • Updated configuration reference documentation with improved examples and variable naming conventions for enhanced clarity.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8f19a83 and 3a085cf.

📒 Files selected for processing (1)

• src/content/docs/docs/reference/configuration.mdx

---

📝 Walkthrough

Walkthrough

Documentation reference and example variable names are updated in the configuration reference guide. File naming convention references are simplified, and example variables are standardized. Only descriptive text and examples are modified; no functional changes.

Changes

Cohort / File(s)	Summary
Documentation Updates src/content/docs/docs/reference/configuration.mdx	Updated FILE equivalent reference and corrected example variable names from USERS, USERS_FILE to USERS, USERSFILE.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 Our docs now shine with clarity bright,
Variables renamed to feel quite right,
FILE and USERS hop in perfect rhyme,
Small changes, but oh what a time! 📝✨

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'Configuration FILE has no underscore' directly aligns with the PR's main objective of removing underscores from FILE option examples in the configuration documentation.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

Tip

Try Coding Plans. Let us write the prompt for your AI agent so you can ship faster (with fewer bugs).
Share your feedback on Discord.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[steveiliop56]

@Rycochet maybe we should include the full environment variable name? So TINYAUTH_AUTH_USERS and TINYAUTH_AUTH_USERSFILE.

[Rycochet]

@steveiliop56 I did wonder about that - but then maybe it should also include the other types (CLI / file) - which then makes it long and unwieldy - my draft PR might make it easier to move into the per-type section so it's more targeted?

[steveiliop56]

For the time being, we can just use

ENVIROMENT_VARIABLE (--cli.flag)

and we can revisit it later with the tabbed configuration.