Add link to documentation page

[pchomik]

Hi,

I found that you added documentation pages for standard and external libraries like SSHLibrary. It will be very helpful to get documentation links to all documentation pages:

• http://robotframework.org/robotframework/#user-guide
• http://robotframework.org/SSHLibrary/

[pekkaklarck]

Could you clarify what link you'd like to be added and where?

[pchomik]

In my opinion the better organization will be to have in Documentation section (http://robotframework.org/#documentation) something like:
User Guide - point to page to select User Guide
Standard Libraries - point to page to select documentation of standard libraries
Built-in tools - point to page to select documentation of built-in tools
User Libraries - point to page with documentation of known libraries like SSHLibrary.
I'm thinking about to have similar organization to "Test Libraries" section.

In this way page have clear organization and is center of knowledge. I know that it is not easy link to different project documentation but at least to libraries maintained by your team (SSHLibrary, Rammbock)

What do you think?

[pekkaklarck]

I definitely don't want external libraries maintained by our team to have any special status. All external libs are already listed under Test libraries / External and I think that's fine. Linking them from multiple places would be confusing and add maintenance work.

Adding links to standard library documentation page (http://robotframework.org/robotframework/#standard-libraries) and possibly also to built-in tools under Documentation / Getting started could be considered because standard libs are special and these links wouldn't need to be maintained in the future. I'm still not totally convinced why listing them under Test libraries / Standard and Tools / Built-in wouldn't be enough.

[Tattoo]

I agree with @pekkaklarck. It's more maintenance work for us to have links in many places and we would have to manually go check that the documentation hasn't been moved -- something that seems to happen frequently especially with new libraries (first it's the README, then it's wiki, then it might be a separate web site).

[pekkaklarck]

I enhanced the note under Documentation section that libs/tools have their own docs. See the new note live in here: http://robotframework.org/#documentation

@pchomik is that note enough for you? I could still consider adding links to standard library docs under Documentation section, but that would be pretty weird especially under the note that libs have their own docs.

If your actual need is having a list of libs/tools that are relevant for you in a single place, the easiest solution is writing such a list yourself and putting it into an internal wiki or some other service.

[pchomik]

@pekkaklarck this is enough.

I was thinking to have some king of central page but I understand your point and the problem. Thank you for enhancement.