Skip to content

Fix runnable Zola example Reddit config - #16

Merged
EthanPlant merged 1 commit into
mainfrom
example-fix
Jul 29, 2026
Merged

EthanPlant merged 1 commit into
mainfrom
example-fix

Conversation

@EthanPlant

@EthanPlant EthanPlant commented Jul 29, 2026 •

Copy link
Copy Markdown
Owner

Fixes the runnable Zola example to use the cleanest preferred form for subreddits. Fixes #2

Summary by CodeRabbit

  • Documentation
    • Clarified that Reddit renderer subreddit values can be entered with or without r/ or /r/.
    • Added examples demonstrating the supported formats.
  • Examples
    • Updated the sample configuration to use a subreddit name without a prefix.

@coderabbitai

coderabbitai Bot commented Jul 29, 2026 •

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: aa9e6b7e-abb9-42cc-bfa8-50f4abd2ef29

📥 Commits

Reviewing files that changed from the base of the PR and between b674104 and d912c9b.

📒 Files selected for processing (3)
  • docs/configuration.md
  • docs/renderers.md
  • examples/zola/elsewhere.toml

📝 Walkthrough

Walkthrough

Reddit renderer documentation now describes subreddit values with or without r/ or /r/. Both documentation examples include /r/example, while the runnable Zola example uses the bare example value.

Changes

Reddit configuration formats

Layer / File(s) Summary
Document and apply subreddit formats
docs/configuration.md, docs/renderers.md, examples/zola/elsewhere.toml
Documentation describes prefixed and unprefixed subreddit formats, adds /r/example examples, and updates the Zola configuration to use subreddit = "example".

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

🚥 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 matches the main change: fixing the runnable Zola Reddit example config.
Linked Issues check ✅ Passed The example config and docs were updated to use and document the preferred subreddit form, matching the linked issue.
Out of Scope Changes check ✅ Passed The docs updates are directly tied to the issue and no unrelated changes are evident.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch example-fix

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

@EthanPlant
EthanPlant merged commit 3e31eb6 into main Jul 29, 2026
6 checks passed
@EthanPlant
EthanPlant deleted the example-fix branch July 29, 2026 08:23
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.

Fix runnable Zola example Reddit config

1 participant