Helper links

[ispyisail]

re:Helper links

As you get into it you discover a few problems

Is it one link per page or many links per page?




If its one link per page you would need to link to a directory page with links to other pages?

If its many links per page I would need some kind of ID system for links?

[Lantis]

Many links per page is ok. You can use anchors to link to specific paragraphs of the wiki.

[d3fz]

It could go both ways, one/multiple links, it will depend on the complexity of the configuration or really long pages (e.g. QoS Download/Upload).

As for help links positioning, I suggest that they are placed inside panels (not at page header), right next to the respective feature/functionality that the user is having trouble with. That way, help links are only shown when needed, reducing clutter and cognitive overload.


Where links redirects to:
1) http://www.gargoyle-router.com/wiki/doku.php?id=basic
2) http://www.gargoyle-router.com/wiki/dok ... e_repeater

And for really long pages/tutorials, we could redirect straight to the wiki section, so the user doesn't need to scan through the whole tutorial searching for a specific section.

Where link redirects to:
http://www.gargoyle-router.com/wiki/dok ... roller_acc

[ispyisail]

I had a little play making a Table before I broke the wiki

https://docs.google.com/spreadsheets/d/ ... sp=sharing

[d3fz]

What do you mean you "broke the wiki" ?

Edit: Oh, I see now. Doesn't look bad, though. More like a mobile version of the wiki in "reader mode", it actually adds more focus to the content. Green links look good too.

[Lantis]

That's the format i ended up using. I'll add the ability to turn these help messages off as well.

How's the progress so far ? Turning these into optional is great, i wonder if we could do the same to alert panels (or at least make them collapsible) ? This would free up some space in mobile, and gives the average user the ability to just them off, if they want to.

If we can get a list of links to help docs and where you think they should be linked from i can format the rest

ispyisail provided a helpful table to map all the necessary links, i'll use that as a reference to add other ones myself.

And last, should i open a new issue on github regarding this new feature, or is that section only oriented for bug reports ?

If you could please reply this post into the "Helper Links" thread created by ispyisail, that would be great to keep track of all posts/ideas.

Thanks.

Yes a new issue is ok. Should use that to run it by Eric before I sink too much time into it.
Your example pic is good to include

[ispyisail]

Should use that to run it by Eric before I sink too much time into it.

yeah

[d3fz]

Done.