Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a "Whirldwind Tour" to the guide #40

Merged
merged 1 commit into from
Jan 26, 2022
Merged

Add a "Whirldwind Tour" to the guide #40

merged 1 commit into from
Jan 26, 2022

Conversation

Technius
Copy link
Member

This is a WIP PR to add a "Whirlwind Tour" to the guide, similar to the brief introduction in the current guide on the wiki.

@Technius Technius mentioned this pull request Jul 31, 2021
11 tasks
@Technius
Copy link
Member Author

I've been occupied with other things recently so any help here would be welcome.

Copy link
Member

@rolandlo rolandlo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In general I pretty much like the whirldwind tour. Pdf annotation and export to pdf/svg/png should definitively be featured more prominently though. While describing how to create different shapes (which is also important), please do also briefly mention the shape recognizer.
Don't hesitate to add more pictures, as that will help the novice to find things and make the reading more comfortable.

I agree with the overview, giving the user the choice to take the whirldwind tour or to look for more specific topics.

@Technius Technius force-pushed the content/tour branch 2 times, most recently from d4b6b00 to 35b1923 Compare January 24, 2022 00:54
@Technius Technius marked this pull request as ready for review January 24, 2022 00:54
@Technius
Copy link
Member Author

I updated the whirlwind tour just now. I pruned out much of the detail that I originally planned to include, as the whirlwind guide should be a sort of 5-10 minute tutorial that demonstrates bare minimum functionality.

I would like to see this merged sooner rather than later. It should not take very much effort to amend the guide in the future.

Copy link
Member

@rolandlo rolandlo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks nice to me. Good job with the icons. I only have minor comments.

docs/guide/whirlwind-tour.md Outdated Show resolved Hide resolved
docs/guide/whirlwind-tour.md Outdated Show resolved Hide resolved

### Temporary tool button bindings

The primary button of each input device will activate the currently selected
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not quite sure, if this is correctly understood in case of a stylus.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've clarified this section.

docs/guide/whirlwind-tour.md Outdated Show resolved Hide resolved
docs/guide/whirlwind-tour.md Outdated Show resolved Hide resolved
docs/guide/whirlwind-tour.md Outdated Show resolved Hide resolved
docs/guide/whirlwind-tour.md Outdated Show resolved Hide resolved
@Technius
Copy link
Member Author

Thanks for the feedback. I inserted more icons and added the LaTeX tool to the tool table.

Copy link
Member

@rolandlo rolandlo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Please go ahead and merge.

@Technius Technius merged commit 0feae87 into site Jan 26, 2022
@Technius Technius deleted the content/tour branch January 26, 2022 07:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants