-
Notifications
You must be signed in to change notification settings - Fork 10
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat: reorganize documentation #330
Conversation
1bde999
to
084a629
Compare
7267128
to
cca76e0
Compare
@ThibaultFy Is it expected that Binder is running all examples (and rebuilding the whole documentation) at launch time? It does not seem very scalable in the long term 🤔 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Love what you did 😍 thanks a lot for this OS contrib !!
I would love to approve but we should wait for Romain review IMO.
@RomainGoussault you should take a look at this !
# - An :ref:`Torch algorithm<substrafl_doc/api/algorithms:Torch Algorithms>` to define the training parameters *(optimizer, train | ||
# function, predict function, etc...)*. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Woops.. good catch
How-to guides for Substra developers | ||
==================================== |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The titles for these sections are
- How-to guides for Substra developers
- How-to guides for deploying Substra
- How-to guides for Substra users
Do you think we could standardize on one formulation? such as "for developing on Substra" and "for using Substra". (unfortunately "deployers" isn't a word.. But I think it might be better to focus on action than on title)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
how-to guide titles are not all standardized but IMO let's merge it as-is and address this in a separate PR
Signed-off-by: SdgJlbl <[email protected]>
Signed-off-by: SdgJlbl <[email protected]>
Signed-off-by: SdgJlbl <[email protected]>
Signed-off-by: SdgJlbl <[email protected]>
Signed-off-by: SdgJlbl <[email protected]>
Signed-off-by: SdgJlbl <[email protected]>
Signed-off-by: SdgJlbl <[email protected]>
Signed-off-by: SdgJlbl <[email protected]>
Signed-off-by: SdgJlbl <[email protected]>
Signed-off-by: SdgJlbl <[email protected]>
9615416
to
00004e2
Compare
The goal of this PR is to reorganise the documentation according to the Diátaxis framework to facilitate access.
TODO