Skip to content

Better describe changes? #14

@DMCShep

Description

@DMCShep

Problem Areas

https://promega.printm3d.com/changelog
Also
https://github.com/PrintM3D/Promega-Docs/commits/master

Current Behavior

GitHub commit log is filled with change descriptions such as "one page and 10 assets modified", "one page modified", "25 pages and 13 assets modified", "Update changing-sliders.md", which requires careful review of each commit to gather intent of why the change was made. It is not immediately clear what changed or why with as many as 25 pages involved.

The promega.printm3d.com changelog has an abundance of "Updated Printed Parts" changes, without any reason for why changes were required or made. This leads to guys with earlier printers like myself not knowing what parts would be of serious benefit and what can be outright ignored. (It does seem some revisions are meant for ease of assembly while others are meant for better printer operation -- obviously only one of those two matters once the printer arrives intact.)

Additionally, the printed parts themselves do not have any visual on the GitBook page, so a "guess and check" approach is required to know if the right part has been downloaded at all, let alone if it matches what you already have or not. Especially for parts where it is important to have the latest revision, this can make it harder to tell what's good and what's not.

Expected Behavior

  1. GitHub commit log adequately describes changes
  2. promega.printm3d.com changelog states why changes were needed and made
  3. Thumbnails for all STL files for clarity of both A) what the part is, and B) what changed between iterations.
  4. Minimum suggested STL revision for each printed part, in case being behind a revision or two is still okay

This would clear a lot of confusion up about the changes going on in the GitBooks. Thank you! 👍

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions