docs: clarifies config file locations and purposes
- 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
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
✅ Recipe Validation Passed
Your recipe(s) are valid and ready for review!
🔍 Next Steps:
- Our team will review your recipe
- If approved, we'll run a security scan
- Once merged, you'll receive $10 in OpenRouter credits (if email provided)
Thanks for contributing to the goose Recipe Cookbook! 🎉
🔍 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.
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
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!
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!
With #5195 approved and merged, there are conflicts now for this PR I believe @blackgirlbytes
With #5195 approved and merged, there are conflicts now for this PR I believe @blackgirlbytes
Resolved the conflicts, should be clean now.
Amazing contributions, @anthonydmays ! Thank you so much for working on this, and for participating in Hacktoberfest 🥺 🖤