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

task-based section in manual #44

Open
otoomet opened this issue Jul 15, 2019 · 3 comments
Open

task-based section in manual #44

otoomet opened this issue Jul 15, 2019 · 3 comments

Comments

@otoomet
Copy link

otoomet commented Jul 15, 2019

Currently the manual is largely tool-based: there are pretty good references to all tools and what these do. However, what I feel is missing is descriptions like "how can I achieve x". For instance, I was unaware there is the duplicate tool and attempted to achieve a similar result with copy-paste. Earlier I have used other inefficient ways to achieve various results.

However, I don't see any obvious place where to add such information. True, there are a number of task-based entries (geo-referencing, tags and others). But what about creating a new section? We have "first steps", perhaps do something like "next steps", that would contain topics like "how to work with vegetation", "how to draw smooth lines", "how to use lidar data" and so on?

Other thoughts?

@dg0yt
Copy link
Member

dg0yt commented Jul 17, 2019

More how-to style documentation, perhaps separately for basic usage and advanced usage, is certainly appreciated.

I wonder if it would make sense to split the documentation in a static reference manual as we have now, and more interactive how-to/tutorial presentations based on https://revealjs.com/ or similar. After all. these presentations could be used in local workshops, too. This is an area for additional contributors, and can be handled in separate repository within in the OpenOrienteering project.

@otoomet
Copy link
Author

otoomet commented Jul 17, 2019

The more interactive part sounds like an idea, given there are contributors who can do revealjs or the like. I have zero experience with javascript but I can easily do markdown. A different way to go is wiki, it's pretty similar to markdown to write but of course you only get static results (afaik). Never looked at where to host it or how to set it up. I can play with GH wiki a bit if you think a wiki might be an idea.

@otoomet
Copy link
Author

otoomet commented Jul 19, 2019

What kind of help do you imagine? I think at that stage the priority is to come up with some ideas and a pathway to go forward.

As I said, I can do something like markdown (or html or some other formats for the matter) including images. I think it is a good idea, revealjs or no revealjs, as it has smaller entry barriers than dedicated web-based methods (but I don't have experience with the latter) and the static text can probably be copied to an interactive platform to a rather large extent.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants