Skip to content

docs: clarifies config file locations and purposes #5210

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
taniandjerry merged 8 commits into from
Oct 29, 2025
Merged

docs: clarifies config file locations and purposes #5210

taniandjerry merged 8 commits into from
Oct 29, 2025

Conversation

@anthonydmays
Copy link
Contributor

@anthonydmays anthonydmays commented Oct 16, 2025 •
edited
Loading

  • 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
  • Documentation
  • Tests
  • Security fix
  • Build / Release
  • Other (specify below)

Testing

Manual review

Related Issues

Relates to #5196

@anthonydmays anthonydmays force-pushed the docs/5196-config-paths branch from 005352c to cf275f1 Compare October 16, 2025 19:10
@anthonydmays anthonydmays marked this pull request as ready for review October 16, 2025 19:10
@anthonydmays anthonydmays requested a review from a team as a code owner October 16, 2025 19:10
@taniandjerry taniandjerry added hacktoberfest Issues awarding points for Hacktoberfest 2025! large Weight label for Hacktoberfest 2025 issues labels Oct 16, 2025
angiejones
angiejones reviewed Oct 17, 2025
View reviewed changes
angiejones
angiejones previously requested changes Oct 17, 2025
View reviewed changes
Copy link
Collaborator

@angiejones angiejones left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@angiejones
Copy link
Collaborator

angiejones commented Oct 17, 2025

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 angiejones dismissed their stale review October 17, 2025 05:27

removing my blocker

@github-actions
Copy link
Contributor

github-actions bot commented Oct 17, 2025

✅ 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
Copy link
Contributor

github-actions bot commented Oct 17, 2025

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

@anthonydmays anthonydmays force-pushed the docs/5196-config-paths branch from ef23af1 to 5e6baf6 Compare October 17, 2025 18:04
@blackgirlbytes
Copy link
Contributor

blackgirlbytes commented Oct 20, 2025

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

@anthonydmays anthonydmays force-pushed the docs/5196-config-paths branch from 5e6baf6 to ce4a77b Compare October 21, 2025 20:49
@anthonydmays
Copy link
Contributor Author

anthonydmays commented Oct 21, 2025

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 anthonydmays mentioned this pull request Oct 21, 2025
Merged
9 tasks
@anthonydmays anthonydmays force-pushed the docs/5196-config-paths branch 3 times, most recently from a0b3641 to dd15a9e Compare October 24, 2025 20:38
@block block deleted a comment from iandouglas Oct 25, 2025
blackgirlbytes
blackgirlbytes reviewed Oct 27, 2025
View reviewed changes
blackgirlbytes
blackgirlbytes approved these changes Oct 27, 2025
View reviewed changes
Copy link
Contributor

@blackgirlbytes blackgirlbytes left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@anthonydmays anthonydmays force-pushed the docs/5196-config-paths branch from dd15a9e to 606a9a2 Compare October 27, 2025 16:34
@anthonydmays
Copy link
Contributor Author

anthonydmays commented Oct 27, 2025

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!

This was linked to issues Oct 29, 2025
goose configure Documentation incorrectly references config.yaml instead of config directory #5196
Closed
goose configure CLI commands incorrectly reference config.yaml instead of config directory #5117
Closed
@taniandjerry
Copy link
Contributor

taniandjerry commented Oct 29, 2025

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

@taniandjerry taniandjerry mentioned this pull request Oct 29, 2025
Closed
5 tasks
@anthonydmays
docs: updates high prio docs
6cd903f 
Signed-off-by: Anthony D. Mays <[email protected]>
@anthonydmays
docs: adds TODO to update goose Version:
c53e95d 
  Version:          1.10.2

goose Locations:
  Config file:      /Users/anthonymays/.config/goose/config.yaml
  Sessions dir:     /Users/anthonymays/.local/share/goose/sessions
  Logs dir:         /Users/anthonymays/.local/state/goose/logs output

Signed-off-by: Anthony D. Mays <[email protected]>
@anthonydmays
docs: renames config-files page and adds redirect
754dec4 
Signed-off-by: Anthony D. Mays <[email protected]>
@anthonydmays
docs: fixes link typo
a397927 
Signed-off-by: Anthony D. Mays <[email protected]>
@anthonydmays
docs: restores full path to primary config file for easier copy/pasting
9223951 
Signed-off-by: Anthony D. Mays <[email protected]>
@anthonydmays
chore: restores windows path to config.yaml
e2da720 
Signed-off-by: Anthony D. Mays <[email protected]>
@anthonydmays
docs: tweak wording to minimize confusion re: path to config files
cfaa84d 
Signed-off-by: Anthony D. Mays <[email protected]>
@anthonydmays
chore: removes TODO to update goose Version:
f3d72a2 
  Version:          1.10.2

goose Locations:
  Config file:      /Users/anthonymays/.config/goose/config.yaml
  Sessions dir:     /Users/anthonymays/.local/share/goose/sessions
  Logs dir:         /Users/anthonymays/.local/state/goose/logs example output

Signed-off-by: Anthony D. Mays <[email protected]>
@anthonydmays anthonydmays force-pushed the docs/5196-config-paths branch from 606a9a2 to f3d72a2 Compare October 29, 2025 19:35
@anthonydmays
Copy link
Contributor Author

anthonydmays commented Oct 29, 2025

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

Resolved the conflicts, should be clean now.

@taniandjerry taniandjerry merged commit 40f4534 into block:main Oct 29, 2025
13 of 14 checks passed
@taniandjerry
Copy link
Contributor

taniandjerry commented Oct 29, 2025

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

@anthonydmays anthonydmays deleted the docs/5196-config-paths branch October 29, 2025 21:55
@github-actions github-actions bot mentioned this pull request Nov 5, 2025
Merged
fbalicchia pushed a commit to fbalicchia/goose that referenced this pull request Nov 7, 2025
@anthonydmays @fbalicchia
docs: clarifies config file locations and purposes (block#5210)
79f799c 
Signed-off-by: Anthony D. Mays <[email protected]>
Signed-off-by: fbalicchia <[email protected]>
BlairAllan pushed a commit to BlairAllan/goose that referenced this pull request Nov 29, 2025
@anthonydmays @BlairAllan
docs: clarifies config file locations and purposes (block#5210)
12b39ae 
Signed-off-by: Anthony D. Mays <[email protected]>
Signed-off-by: Blair Allan <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@blackgirlbytes blackgirlbytes blackgirlbytes approved these changes

@angiejones angiejones Awaiting requested review from angiejones

@dianed-square dianed-square Awaiting requested review from dianed-square

@iandouglas iandouglas Awaiting requested review from iandouglas

Assignees

@anthonydmays anthonydmays

Labels

hacktoberfest Issues awarding points for Hacktoberfest 2025! hacktoberfest-accepted large Weight label for Hacktoberfest 2025 issues

Projects

None yet

Milestone

No milestone

4 participants

@anthonydmays @angiejones @blackgirlbytes @taniandjerry