search

bevyengine / bevy-website

The source files for the official Bevy website
https://bevy.org
MIT License
225 stars 382 forks source link

Add a "Report a Problem with this page" button #2135

Closed viridia closed 3 weeks ago

viridia commented 4 weeks ago

Given the rapid pace at which Bevy evolves, we have an ongoing problem with documentation quickly getting out of date. One way to mitigate this would be to add a "Report a problem" button, which would then file a Github issue. This would let us crowdsource the detection of problems.

I've done a bit of research (well, I asked claude.ai to do it for me) on this, here's the result: https://claude.ai/share/8f42365e-6f3e-4fc2-b700-71f57a4a18f6

Based on that, I think that microfeedback might work well enough for our needs: https://github.com/microfeedback/microfeedback-button - this has a plugin which can link with github issues.

The task then is to spend some time integrating microfeedback with our documentation.

TrialDragon commented 3 weeks ago

Tbh, microfeedback feels like overkill and requires us to deploy a microservice to serve as backend. I think a button with a link to open a new issue with a template for this specific use case is a simpler solution.