Skip to content
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

docs: updating goose hints info #1141

Merged
merged 4 commits into from
Feb 7, 2025
Merged

docs: updating goose hints info #1141

merged 4 commits into from
Feb 7, 2025

Conversation

blackgirlbytes
Copy link
Collaborator

@blackgirlbytes blackgirlbytes commented Feb 7, 2025 •
edited
Loading

goosehints are an easy concept..so trying to reduce the confusion on slack about it with more deets.

  1. Removed mentions of jinja templating as .goosehints no longer uses it. Confirmed by Salman
  2. Added clarity about global and local hints. People on Discord seemed confused.
  3. Added clarity of which hints would take precedence if both are used
  4. Added a best practice

Out of practice with doc writing..what to remove or add?

@blackgirlbytes blackgirlbytes self-assigned this Feb 7, 2025
@github-actions GitHub Actions
Copy link

github-actions bot commented Feb 7, 2025 •
edited
Loading

PR Preview Action v1.6.0

🚀 View preview at
https://block.github.io/goose/pr-preview/pr-1141/

Built to branch gh-pages at 2025-02-07 16:47 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

michaelneale
michaelneale approved these changes Feb 7, 2025
View reviewed changes
Copy link
Collaborator

@michaelneale michaelneale left a comment

Choose a reason for hiding this comment

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

yes, looks good, good catch forgot doesn't do jinja

@blackgirlbytes blackgirlbytes merged commit 5f8b522 into main Feb 7, 2025
3 checks passed
@blackgirlbytes blackgirlbytes deleted the hints-doc-update branch February 7, 2025 17:29
Acumen-Desktop pushed a commit to Acumen-Desktop/goose that referenced this pull request Feb 7, 2025
@blackgirlbytes @angiejones @Acumen-Desktop
docs: updating goose hints info (block#1141)
319797a 
Co-authored-by: Angie Jones <jones.angie@gmail.com>
laanak08 pushed a commit that referenced this pull request Feb 13, 2025
@blackgirlbytes @angiejones @laanak08
docs: updating goose hints info (#1141)
f04c922 
Co-authored-by: Angie Jones <jones.angie@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@michaelneale michaelneale michaelneale approved these changes

@angiejones angiejones angiejones approved these changes

@acekyd acekyd Awaiting requested review from acekyd

@EbonyLouis EbonyLouis Awaiting requested review from EbonyLouis

Assignees

@blackgirlbytes blackgirlbytes

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@blackgirlbytes @michaelneale @angiejones