Adds a feedback widget to collect user input about your documentation. Helps identify unclear sections, missing information, and areas for improvement directly from readers.

What it provides

• Floating feedback button on all documentation pages
• Simple form for users to report issues or suggestions
• Dashboard to manage and respond to feedback
• Analytics to identify common problems
• Integration with your existing documentation workflow

Types of feedback collected

• Page-specific issues (“this section is unclear”)
• Missing information requests
• Technical errors and broken links
• General suggestions for improvement
• User experience feedback

Configuration

IMPORTANT: Requires a PushFeedback account to collect and manage feedback.

# conf.py
extensions = ['sphinx_pushfeedback']

# Required: your PushFeedback project ID
pushfeedback_project = 'your-project-id-here'

# Optional: customize widget appearance
pushfeedback_widget_config = {
    'button_text': 'Feedback',
    'button_position': 'right',
    'theme': 'light',
}

Workflow

1. Users click the feedback button on any page
2. They fill out a simple form about their issue
3. Feedback appears in your PushFeedback dashboard
4. You can respond, categorize, and track resolution
5. Use insights to improve your documentation

Benefits for documentation teams

• Identifies pain points you might miss
• Provides direct user input for prioritizing improvements
• Reduces support tickets by catching issues early
• Shows which pages need attention
• Helps measure documentation effectiveness