Skip to content

refactor: generate mdx docs with tabs for each config option#996

Merged
steveiliop56 merged 1 commit into
mainfrom
refactor/tabbed-docs-values
Jul 13, 2026
Merged

refactor: generate mdx docs with tabs for each config option#996
steveiliop56 merged 1 commit into
mainfrom
refactor/tabbed-docs-values

Conversation

@steveiliop56

@steveiliop56 steveiliop56 commented Jul 12, 2026

Copy link
Copy Markdown
Member

Summary by CodeRabbit

  • New Features

    • Added the TINYAUTH_CONFIGFILE environment setting for specifying a configuration file.
    • Added guidance for configuring the setting in the example environment file.
  • Documentation

    • Improved the organization and visibility of authentication label-provider configuration guidance.
    • Updated configuration metadata to ensure the new setting is included consistently in generated configuration references.

@dosubot dosubot Bot added the size:M This PR changes 30-99 lines, ignoring generated files. label Jul 12, 2026
@coderabbitai

coderabbitai Bot commented Jul 12, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: d15d8e6f-ad6f-4b0f-b04b-a1e44ebc7acc

📥 Commits

Reviewing files that changed from the base of the PR and between 791adbb and 7380cbf.

⛔ Files ignored due to path filters (2)
  • gen/docs/gen_env.go is excluded by !**/gen/**
  • gen/docs/gen_md.go is excluded by !**/gen/**
📒 Files selected for processing (2)
  • .env.example
  • internal/model/config.go

📝 Walkthrough

Walkthrough

The configuration model now marks ConfigFile for generation, and .env.example adds TINYAUTH_CONFIGFILE while moving TINYAUTH_LABELPROVIDER into the early configuration block.

Changes

Configuration alignment

Layer / File(s) Summary
Config file metadata and environment template
.env.example, internal/model/config.go
ConfigFile moves before LabelProvider and gains gen:"include" metadata; .env.example adds TINYAUTH_CONFIGFILE and relocates TINYAUTH_LABELPROVIDER="auto".

Estimated code review effort: 1 (Trivial) | ~3 minutes

Possibly related PRs

Suggested reviewers: scottmckendry

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly matches the PR objective and the apparent docs-generation refactor work.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch refactor/tabbed-docs-values

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

Comment @coderabbitai help to get the list of available commands.

@codecov

codecov Bot commented Jul 12, 2026

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 0% with 44 lines in your changes missing coverage. Please review.

Files with missing lines Patch % Lines
gen/docs/gen_md.go 0.00% 42 Missing ⚠️
gen/docs/gen_env.go 0.00% 2 Missing ⚠️

📢 Thoughts on this report? Let us know!

@dosubot dosubot Bot added the lgtm This PR has been approved by a maintainer label Jul 12, 2026
@steveiliop56 steveiliop56 merged commit b62bb2d into main Jul 13, 2026
5 checks passed
@steveiliop56 steveiliop56 deleted the refactor/tabbed-docs-values branch July 13, 2026 15:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

lgtm This PR has been approved by a maintainer size:M This PR changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants