thoth-station / adviser

The recommendation engine for Python software stacks and Dependency Monkey in project Thoth.
https://thoth-station.github.io
GNU General Public License v3.0
34 stars 13 forks source link

Create a concise documentation on how adviser works #2275

Open mayaCostantini opened 2 years ago

mayaCostantini commented 2 years ago

Is your feature request related to a problem? Please describe.

As a user of Thoth, I would like to have access to a document which summarizes the mechanism behind Thoth advises to understand how they work, what are the elements that are taken into account for providing an advice (i.e. prescriptions), etc.

Describe the solution you'd like

Create one page of documentation containing a diagram or any kind of visual summary of adviser mechanism.

Describe alternatives you've considered

Redirect users to the adviser documentation already available at https://thoth-station.ninja/docs/developers/adviser/index.html

Additional context

This page could be thought of as a presentation of adviser to display on Thoth's website for a quick overview of the component.

mayaCostantini commented 2 years ago

/priority important-soon

mayaCostantini commented 2 years ago

/assign

mayaCostantini commented 2 years ago

/sig stack-guidance

sesheta commented 2 years ago

Issues go stale after 90d of inactivity. Mark the issue as fresh with /remove-lifecycle stale. Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

/lifecycle stale

codificat commented 2 years ago

/remove-lifecycle stale

sesheta commented 2 years ago

Issues go stale after 90d of inactivity. Mark the issue as fresh with /remove-lifecycle stale. Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

/lifecycle stale

Gkrumbach07 commented 2 years ago

may be related: https://github.com/thoth-station/core/issues/451

harshad16 commented 2 years ago

/remove-lifecycle stale /lifecycle frozen