goose icon indicating copy to clipboard operation
goose copied to clipboard

docs: clarifies config file locations and purposes

Open anthonydmays opened this issue 4 months ago • 6 comments

  • docs: updates high prio docs
  • docs: adds TODO to update goose Version: Version: 1.10.2

Summary

This change updates documentation to clarify the location and purpose of docs. Instead of only mentioning config.yaml, the directory is referenced instead when referring to config files generally.

Type of Change

  • [ ] Feature
  • [ ] Bug fix
  • [ ] Refactor / Code quality
  • [ ] Performance improvement
  • [x] Documentation
  • [ ] Tests
  • [ ] Security fix
  • [ ] Build / Release
  • [ ] Other (specify below)

Testing

Manual review

Related Issues

Relates to #5196

anthonydmays avatar Oct 16 '25 17:10 anthonydmays

hey Anthony! There's only a single configuration file. The rest are simply backups. goose only reads one.

Don't see the need for the PR. Let me know if you disagree

oh i see the issue now. these files:

~/.config/goose/
├── config.yaml              # Provider, model, extensions, general settings
├── permission.yaml          # Tool permission levels (user-configured)
├── secrets.yaml             # Secrets (when keyring is disabled)
└── permissions/             # Runtime permission decisions (auto-managed)
    └── tool_permissions.json

angiejones avatar Oct 17 '25 05:10 angiejones

Recipe Validation Passed

Your recipe(s) are valid and ready for review!

🔍 Next Steps:

  1. Our team will review your recipe
  2. If approved, we'll run a security scan
  3. Once merged, you'll receive $10 in OpenRouter credits (if email provided)

Thanks for contributing to the goose Recipe Cookbook! 🎉

github-actions[bot] avatar Oct 17 '25 18:10 github-actions[bot]

🔍 Recipe Security Scan Results

Status: APPROVED - All recipes passed security scan

📊 Scan Summary:

  • Total recipes scanned: 1

📋 Individual Recipe Results: ✅ Recipe 1: APPROVED (LOW risk)

🔗 View detailed scan results in the workflow artifacts.

github-actions[bot] avatar Oct 17 '25 18:10 github-actions[bot]

hi anthony! thanks for your contribution..looks like you have a few failing tests..for the documentation preview..it says there may be broken links

blackgirlbytes avatar Oct 20 '25 20:10 blackgirlbytes

hi anthony! thanks for your contribution..looks like you have a few failing tests..for the documentation preview..it says there may be broken links

@blackgirlbytes Bad find/replace, resolved now!

anthonydmays avatar Oct 21 '25 20:10 anthonydmays

besides removing that to comment on line 59 in the creating plans documenting, this lgtm! thanks for your contribution! also dont worry about the failing live providers test. that's unrelated to your PR.

TODO removed. I'll send a separate PR to update the goose info example it's ready. Thanks for your help!

anthonydmays avatar Oct 27 '25 16:10 anthonydmays

With #5195 approved and merged, there are conflicts now for this PR I believe @blackgirlbytes

taniandjerry avatar Oct 29 '25 18:10 taniandjerry

With #5195 approved and merged, there are conflicts now for this PR I believe @blackgirlbytes

Resolved the conflicts, should be clean now.

anthonydmays avatar Oct 29 '25 19:10 anthonydmays

Amazing contributions, @anthonydmays ! Thank you so much for working on this, and for participating in Hacktoberfest 🥺 🖤

taniandjerry avatar Oct 29 '25 20:10 taniandjerry