Repository navigation
JCL-73: Reorganize, rework high-level documentation - #326
Conversation
|
Vercel would have been in handy on this PR. |
| +---------------- | ||
| public class ClientSample { | ||
|
|
||
| public CompletionStage<SolidResource> useTheHighLevelAsyncClient() { |
There was a problem hiding this comment.
I would have preferred to see the .toCompletableFuture().join() example.
There was a problem hiding this comment.
When it comes to async APIs, you generally shouldn't be calling .join(). Rather, it should be async all through the entire system (as in this example).
If you're calling .join(), it often means that your're in a synchronous context, in which case, you should generally be using the synchronous API in the first place.
|
I like how it flows nicely, from one topic to the next, from simple to complicated. |
|
We provide a test Client ID Document, should we also provide a test |
Co-authored-by: Timea <4144203+timea-solid@users.noreply.github.com>
Co-authored-by: Timea <4144203+timea-solid@users.noreply.github.com>
That would be a bit of a security problem :-) So no, we should not provide one. |
Reactive authentication is definitely important, but it is also an implementation detail. If someone were to extend these libraries to write a new authentication mechanism (e.g. GNAP), that person would need to know about reactive authentication, but for a general user of our library, this isn't something they would need to know (in fact, if they truly don't need to understand this, it is a success) |
This reworks the documentation in preparation for a review of the client libraries.
This is a rather significant rework of the existing documentation. It features less architectural detail and tries for an audience that will be unfamiliar with the internal structure of the code (which will be the more typical case).
The home page now looks like this
The getting started page is:
The usage examples page gets into more detail of the API:
The session management page is about OpenID-based sessions and using Access Grants
And the Data Modeling page gets into RDF Wrapping: