Skip to content

Conversation

@blackgirlbytes
Copy link
Contributor

@blackgirlbytes blackgirlbytes commented Nov 2, 2025

Adding documentation about troubleshooting diagnostics / reporting as requested by @DOsinga
also removed hacktoberfest messaging from readme

- Rename troubleshooting.md to known-issues.md
- Update title and heading from 'Troubleshooting' to 'Known Issues'
- Update all documentation references to use /docs/known-issues
- Change internal content from 'troubleshooting' to 'debugging' where appropriate
- Update links in installation, extensions, session management, and security guides
- Fix typo in tips.md (Inlcude → Include)
- Keep blog post reference as 'troubleshooting guide' (refers to demo app docs, not goose docs)
- Add new help-and-feedback.md guide covering diagnostics, bug reports, and feature requests
- Add session diagnostics command to CLI commands guide with full options and examples
- Cross-reference between guides to avoid duplication
- Link configuration files mentions to config-files documentation
- Use accurate language about multiple configuration files vs single config.yaml
- Follow established documentation patterns with tabs, callouts, and consistent formatting
- Include privacy warnings and best practices for each feature
- Remove Hacktoberfest 2025 section as the event is over
- Add 'Need Help?' section with links to diagnostics and known issues
- Reorganize links for better user experience when troubleshooting
- Add prominent tip at top of known issues guide to generate diagnostic reports
- Update 'Need Further Help?' section with clear 2-step process
- Emphasize diagnostic reports make debugging faster for community
- Use relative links to diagnostics guide within troubleshooting docs
- Add friendly tip at top encouraging diagnostic reports for faster support
- Update 'Need Further Help?' section with welcoming tone
- Link directly to diagnostics-system section for targeted help
- Maintain community-first approach while encouraging better debugging info
@blackgirlbytes blackgirlbytes requested a review from a team as a code owner November 2, 2025 14:14
@github-actions
Copy link
Contributor

github-actions bot commented Nov 2, 2025

PR Preview Action v1.6.0
Preview removed because the pull request was closed.
2025-11-02 19:22 UTC

- Change 'debugging' back to 'troubleshooting' in running-tasks.md Debug Mode section
- Restore 'and troubleshooting' text in tips.md Add Logging to Recipes section
- Change 'debugging step' back to 'troubleshooting step' in known-issues.md macOS permissions section

These changes preserve the original troubleshooting terminology that was inadvertently changed.
- Remove Hacktoberfest 2025 section from CONTRIBUTING.md while preserving Quick Responsible AI Tips
- Add Responsible AI-Assisted Coding Guide link to README Quick Links section
- Fix broken diagnostic report links in known-issues.md and README.md to use correct paths
- Update documentation URLs to include proper /troubleshooting/ path prefix
@blackgirlbytes blackgirlbytes merged commit de0afbe into main Nov 2, 2025
19 of 20 checks passed
michaelneale added a commit that referenced this pull request Nov 3, 2025
* main:
  Fixes Gemini API parse issue by converting nullable type arrays to single types in tool schemas (#5530)
  Troubleshooting diagnostics doc (#5526)
  fix link to Ollama FAQ (#5531)
  docs: remove speech-mcp (#5514)
  fix: adds ProviderRetry to openai provider (#5518)
  docs: extensions directory minor updates (#5466)
  Docs/json recipe support (#5492)
  docs: recipe buttons (#5507)
  Improve system theme detection and fallback (#5427)
  [Autovisualiser] remove unnecessary content from mermaid HTML template (#5505)
  Improve subagents docs (#5484)
  FIX: prefer linux in WSL and add INSTALL_OS override for CLI (#5215)
  Propagate session ID in LLM and MCP requests (#5165)
  feat: YT Short for Canva MCP + goose (#5495)
katzdave added a commit that referenced this pull request Nov 3, 2025
…se into dkatz/manual-compact-fix-usage

* 'dkatz/manual-compact-fix-usage' of github.com:block/goose: (35 commits)
  Fix image processing (#5544)
  docs: AI attribution for PRs (#5547)
  chore(tests/mcp): testing for MCP sampling (#5456)
  docs: adding HOWTOAI.md (#5533)
  added configuration content, also added signoff, fix merging issue with another commit by creating a clean branch. removed and closed commits that caused signoff issues. (#5519)
  Fixes Gemini API parse issue by converting nullable type arrays to single types in tool schemas (#5530)
  Troubleshooting diagnostics doc (#5526)
  fix link to Ollama FAQ (#5531)
  docs: remove speech-mcp (#5514)
  fix: adds ProviderRetry to openai provider (#5518)
  docs: extensions directory minor updates (#5466)
  Docs/json recipe support (#5492)
  docs: recipe buttons (#5507)
  Improve system theme detection and fallback (#5427)
  [Autovisualiser] remove unnecessary content from mermaid HTML template (#5505)
  Improve subagents docs (#5484)
  FIX: prefer linux in WSL and add INSTALL_OS override for CLI (#5215)
  Propagate session ID in LLM and MCP requests (#5165)
  feat: YT Short for Canva MCP + goose (#5495)
  Change Recipes Test Script (#5457)
  ...
katzdave added a commit that referenced this pull request Nov 4, 2025
* 'main' of github.com:block/goose: (21 commits)
  Manual compaction counting fix + cli cleanup (#5480)
  chore(deps): bump prismjs and react-syntax-highlighter in /ui/desktop (#5549)
  fix: remove qwen3-coder from provider/mcp smoke tests (#5551)
  fix: do not build unsigned desktop app bundles on every PR in ci. add manual option. (#5550)
  fix: update Husky prepare script to v9 format (#5522)
  Fix 404 for responsible coding guide (#5543)
  fix hermit `text file busy` issues on linux (#5372)
  Fix image processing (#5544)
  docs: AI attribution for PRs (#5547)
  chore(tests/mcp): testing for MCP sampling (#5456)
  docs: adding HOWTOAI.md (#5533)
  added configuration content, also added signoff, fix merging issue with another commit by creating a clean branch. removed and closed commits that caused signoff issues. (#5519)
  Fixes Gemini API parse issue by converting nullable type arrays to single types in tool schemas (#5530)
  Troubleshooting diagnostics doc (#5526)
  fix link to Ollama FAQ (#5531)
  docs: remove speech-mcp (#5514)
  fix: adds ProviderRetry to openai provider (#5518)
  docs: extensions directory minor updates (#5466)
  Docs/json recipe support (#5492)
  docs: recipe buttons (#5507)
  ...
fbalicchia pushed a commit to fbalicchia/goose that referenced this pull request Nov 7, 2025
BlairAllan pushed a commit to BlairAllan/goose that referenced this pull request Nov 29, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants