feat: add markdown generation to config generator

[steveiliop56]

Summary by CodeRabbit

• Chores
  • Restructured example environment configuration files with section headers for improved organization.
  • Removed legacy YAML configuration template example.
  • Updated build system to exclude auto-generated documentation files.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

---

📝 Walkthrough

Walkthrough

This pull request removes default values from .env.example, deletes the entire config.example.yaml file, and adds a .gitignore entry for generated markdown documentation. The changes convert concrete configuration templates into minimal placeholder structures without altering runtime behavior.

Changes

Cohort / File(s)	Summary
Configuration Examples .env.example, config.example.yaml	Removed concrete default values and example configurations, converting templates to minimal placeholders. Deleted comprehensive config.example.yaml entirely.
Build Artifacts .gitignore	Added comment and new entry to ignore generated markdown file /config.gen.md.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

• #647: Converts example env/config files by removing concrete defaults in favor of templates and auto-generated placeholders.

Poem

🐰 Hoppy trails through configs neat,
Default values we now delete,
Templates clean, placeholders bright,
Generation takes the flight! ✨

🚥 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 references markdown generation for a config generator, which aligns with .gitignore changes adding config.gen.md. However, the main changes involve removing defaults from .env.example and deleting config.example.yaml entirely, making the title only partially related to the changeset's primary scope.
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
• Commit unit tests in branch feat/gen-markdown-config

---

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.}

[codecov]

Codecov Report

❌ Patch coverage is 0% with 123 lines in your changes missing coverage. Please review.
✅ Project coverage is 15.61%. Comparing base (3f30722) to head (b91db19).
⚠️ Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
gen/gen_md.go	0.00%	67 Missing ⚠️
gen/gen_env.go	0.00%	39 Missing ⚠️
gen/gen.go	0.00%	17 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #652      +/-   ##
==========================================
- Coverage   15.96%   15.61%   -0.35%     
==========================================
  Files          48       49       +1     
  Lines        3515     3592      +77     
==========================================
  Hits          561      561              
- Misses       2897     2974      +77     
  Partials       57       57              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.