Arksine / moonraker

Web API Server for Klipper
https://moonraker.readthedocs.io
GNU General Public License v3.0
1.02k stars 392 forks source link

[Enhancement] Add docs link to the repository metadata #796

Closed HumbleDeer closed 5 months ago

HumbleDeer commented 5 months ago

Is your feature request related to a problem? Please describe

The repository lacks a quick link to the documentation in the about/sidebar.

This is especially noticeable to those browsing on a mobile browser, as the About section is the first thing to apear topmost of the page. Example below:

repo_about-section

Describe the solution you'd like

Adding the website is fairly simple and a trivial task (once you know about it).

Steps to accomplish this:

  1. Locate the settings icon on the About section repo_about-gear
  2. Fill in the website URL and save the changes moonraker_repo_edit-details
  3. Admire your relentless dedication to providing for the people moonraker_about-site-mobile moonraker_about-site-desktop

Additional information

This is optional, and merely an enhancement for SEO. The suggestion comes out of my own experience in managing repositories for projects, and experience with what makes a difference in QOL and ease of use.

If this does not follow your procedure or standards, feel free to close this PR.

Arksine commented 5 months ago

Done. Thanks for the tip.