SoftFever / OrcaSlicer

G-code generator for 3D printers (Bambu, Prusa, Voron, VzBot, RatRig, Creality, etc.)
https://discord.gg/P4VE9UY9gJ
GNU Affero General Public License v3.0
7.53k stars 905 forks source link

Need wiki and settings explanations #5822

Closed otede closed 2 weeks ago

otede commented 5 months ago

Is there an existing issue for this feature request?

Is your feature request related to a problem?

  1. From an end-user perspective, if considered in yes or no manner, Orca settings are undocumented. The user has to know what a setting does from non-Orca-related resources.
  2. If there's an Orca-specific handling of a setting user is at a loss. Example https://www.reddit.com/r/OrcaSlicer/comments/1dm89rx/support_threshold_angle_ignored/
  3. Orca's interface is full of clickable setting names that lead to nowhere (no actual wiki articles as suggested by popups)
  4. Orca's wiki is virtually non-existent

Which printers will be beneficial to this feature?

All

Describe the solution you'd like

  1. Establish a wiki or link to an external one. As an interim measure maybe something like this https://3dprinterly.com/cura-settings-ultimate-guide-settings-explained-how-to-use/
  2. Create in-Orca equivalent to https://github.com/Ghostkeeper/SettingsGuide - an in-app illustrated guide that pops up on hover for individual slicer settings

Describe alternatives you've considered

Cura. Can't use anymore with new printer from Bambu Lab.

Additional context

No response

My experience with discovering there's no wiki:

How to reproduce

Go to https://github.com/SoftFever/OrcaSlicer/wiki/
Click on any of the 3 links there

Actual results

Links not opening any new pages. The site reloads. Expected results

A wiki of some sort maybe... When I manually edited the link I got to https://github.com/SoftFever/OrcaSlicer/wiki/Print-settings where just the following is listed: Seam Axiliary fan Chamber temperature Air filtration/Exhaust fan Single Extruder Multimaterial Precise wall Is that it?

sharky98 commented 3 months ago

I really like the https://github.com/Ghostkeeper/SettingsGuide in-app documentation. Here how I would see a multi-step implementation of this.

  1. Create a Markdown file for each setting, organized by folder.
  2. Create a Github Page site, using the default Jekyll static site generator[^1].
  3. Create a viewer inside Orca Slicer to show the Github Page site of the specific setting.
  4. Evolve the viewer inside Orca Slicer to show a local rendered view of the Markdown files.

[^1]: If we want to go fancy, we could use another static site generator (MkDocs, Docsify or Docusaurus) combined with custom Github Action.

github-actions[bot] commented 3 weeks ago

Orca bot: this issue is stale because it has been open for 90 days with no activity.

github-actions[bot] commented 2 weeks ago

Orca bot: This issue was closed because it has been inactive for 7 days since being marked as stale.