Details
-
Improvement
-
Resolution: Fixed
-
Major
-
None
-
1.8.1, 2.0
-
None
-
Security Level: Public
-
None
Description
The various SDK pages, and the SDK docs as well, should probably have prominent links to the Developer's Guide.
As I understand it, a lot of the common overview of how to develop with Couchbase Server is meant to be in the Developer's Guide, including important best practices and helpful examples. The individual SDK docs are lower level items and specific usage items, but don't really cover general Couchbase Server development that applies to any SDK.
I think the SDK pages should all feature a prominent link, near the top, to the Developer's Guide. I think they should also include links to specific parts of the Developer's Guide wherever appropriate. This way, a PHP developer, for example, who is looking at the setMulti method documentation, will easily find that we have a whole section on bulk operations in the Developer's Guide.
Right now, sticking with the PHP example, the only link is at the very bottom of the /develop/php/current page, buried inside some nameless paragraph. Very hard to find, and I doubt most people will read that far.