Add docs outline with Antora skeleton #554
Conversation
| [[registered-client-repository]] | ||
| == `RegisteredClientRepository` / `RegisteredClient` | ||
|
|
||
| This section is under construction. |
There was a problem hiding this comment.
@Buzzardo Is this the appropriate wording to use for TODO sections?
There was a problem hiding this comment.
The heading is a problem. With only the two object names, there is no indication of what you are going to say about them. Should it be "Using RegisteredClientRepository and RegisteredClient" or "Choosing between RegisteredClientRepository and RegisteredClient"?
Note that, in either case, I replaced the slash with "and". We see a slash used that way all the time in informal documents (email and so on), but using a slash in place of a conjunction is bad practice in formal documents (as all documentation is).
The "under construction" wording is fine. Would it be better to not show pages that have no content, though?
There was a problem hiding this comment.
@Buzzardo, regarding showing no-content pages, I'm hoping to begin linking between sections of the guide based on your recommendation to link early, link often 😉 (even before the sections are finished). While some things will change, I'm hoping we can create some semblance of structure prior to writing the content for each section.
There was a problem hiding this comment.
Regarding the headings, I agree and think we can meet to discuss good headings for these sections in the coming weeks. In the meantime, I'm going to go ahead and merge what I've got here to just match the initial draft outline, and we'll address this iteratively.
|
Merged via 438dd3e |
No description provided.