Documentation development

I’m getting started on a new version of the downloadable manual for Seamly2D (and probably also SeamlyMe) and am starting this thread to discuss this effort.

@Grace I assume the “Seamly2D User Manual” section on this page: https://wiki.seamly.io/wiki/User_Manual is what needs to be made into a PDF? I might need a few things, like maybe the logo.

You also mentioned videos, can you elaborate on that? What is the project looking for there?

I’ll post updates when I have any!

2 Likes

Here’s the logos and shortcut icons in svg format.

Seamly2D_logo

seamlyme_logo_rev20

2d_shortcuts

me_shortcuts.svg_rev2

2 Likes

A number of people started using Seamly by following this video… Hence the panty pattern in the tutorials. Many things have changed since then and I think a new one will be helpful to beginners. Here’s a link to the original:

1 Like

Wow, thank you!

1 Like

Ah, ok. Let me give it some thought, and get back to it. I’ll prioritize the manuals.

(I, too, got started with videos, though not this one specifically.)

2 Likes

Ok! I have one small result from my docs generation effort: I’ve made a single-page, printable shortcut quick reference:

Seamly2D Shortcut Quick Reference - A4.pdf (95.8 KB)

Seamly2D Shortcut Quick Reference - LTR.pdf (94.1 KB)

I’ll put these on the wiki soon, and will upload the source files to Github. Flag me if you find any typos.

4 Likes

Wow! Very nice and handy. Thank you.

In the LTR document, the Curve section needs to have the coloured background.

Other than that, I didn’t see anything. :smiley:

1 Like

Oops! Replaced the doc in my original post.

1 Like

Thank you very much @Claudine ! :blush:

1 Like

Thanks Claudine. Looks great to me. :slight_smile:

You can certainly upload it to the Wki, but I’d hold off on uploading anything to Github for now. We dicussed it earlier today during a staff meeting, and we’re not sure what to do at this time with distributing documentation with the apps. There’s currently no specific place in the repo for docs, and there is nothing currently in the ci workflow to deploy docs with the releases. Once we figure out how we want to handle docs, we’ll certainly let you know.

Again Thanks for your efforts.

3 Likes