docs: add book structure and basic documentation #51
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
salasberryfin
force-pushed
the
create-initial-book-structure
branch
from
06306c0
to
b53a6a3
Compare
Danil-Grigorev
approved these changes
May 29, 2024
| @@ -0,0 +1,12 @@ | |||
| # Summary | |||
There was a problem hiding this comment.
We can later explore making summary autogenerated, as this may be outdated with manual edits in the future.
There was a problem hiding this comment.
Sounds good. When we work on publishing this as a book, we'll have to add build scripts (upstream uses Makefile) and we can also work on having an automatically updated summary.
|
I think this should cover #20 as well, thanks Carlos for working on it, LGTM |
Signed-off-by: Carlos Salas <carlos.salas@suse.com>
salasberryfin
force-pushed
the
create-initial-book-structure
branch
from
b53a6a3
to
44d8693
Compare
|
Thanks for the review @Danil-Grigorev. I updated the PR with a reference to |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR adds basic documentation on how to install the provider. The docs are structured to support the creation of a book in line with most upstream CAPI projects (for example CAPG).
The documentation is a work in progress and this PR is only a basic scaffolding to build a more complete reference on top of it.