Documentation: link to feedback form is broken

[nmstoker]

• This is actually a bug report.
• I am not getting good LLM Results
• I have tried asking for help in the community on discord or discussions and have not received a response.
• I have tried searching the documentation and have not found an answer.

Describe the bug
In the documentation, at the bottom of each page you use a feedback feature with a smily face and a sad face. Clicking on them sends basic feedback but it then offers a link for specific feedback, pointing at this URL:

https://python.useinstructor.com/contributing/...

As there is nothing at that URL you get a 404.

The options are either:

• figure out how to hide that feedback link
• fix it so it points at an actual form where information is gathered

To Reproduce

• Open docs here:https://python.useinstructor.com/
• Scroll to bottom of page
• Click on sad face
• Click on "feedback form"
• Observe 404

Expected behavior
Either that link should not be shown at all or clicking it should take you to a feedback form.

Screenshots

PS looks like a great repo - thanks for making it available! 🙂

[dosubot]

To address the broken feedback form link in the documentation, you'll need to update the href attribute in the mkdocs.yml file to point to the correct URL of your feedback form. If you don't have a new URL yet and wish to remove the feedback option temporarily, you can either comment out or remove the feedback section in the extra configuration.

Here's a quick guide:

1. To Correct the Link: Locate the extra.analytics.feedback section in your mkdocs.yml file. Replace the placeholder URL in the href attribute with the actual URL of your feedback form. For example:

feedback:
  note: >- 
    Help us improve this page by
    using our <a href="https://example.com/feedback" target="_blank" rel="noopener">feedback form</a>.

2. To Hide the Feedback Form: If you prefer to hide it, comment out or remove the feedback section under extra.analytics in the mkdocs.yml file. Commenting out can be done by adding a # symbol at the beginning of each line in the section.

After making the necessary updates, remember to rebuild your MkDocs site to apply the changes. Ensure you have the required permissions to edit the mkdocs.yml file, or contact someone who does if you're unable to make these changes yourself.

Sources

• mkdocs.yml

About Dosu

This response is meant to be useful and save you time. It is not meant to be a precise solution, but rather a starting point for your own research.

Help me be more useful! Please leave a 👍 if this is helpful and 👎 if it is irrelevant.

If you want to continue the conversation, start your reply with @dosu-bot.