feat: reorganize documentation #330
Merged
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
This was referenced Jul 20, 2023
SdgJlbl
force-pushed
the
reorganise-doc
branch
4 times, most recently
from
1bde999
to
084a629
Compare
SdgJlbl
force-pushed
the
reorganise-doc
branch
3 times, most recently
from
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 🤔 |
oleobal
reviewed
Jul 24, 2023
ThibaultFy
reviewed
Jul 31, 2023
There was a problem hiding this comment.
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 !
Comment on lines
-501
to
-497
| # - An :ref:`Torch algorithm<substrafl_doc/api/algorithms:Torch Algorithms>` to define the training parameters *(optimizer, train | ||
| # function, predict function, etc...)*. |
oleobal
reviewed
Aug 1, 2023
Comment on lines
1
to
2
| How-to guides for Substra developers | ||
| ==================================== |
There was a problem hiding this comment.
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)
oleobal
approved these changes
Aug 1, 2023
Signed-off-by: SdgJlbl <sarah.diot-girard@owkin.com>
Signed-off-by: SdgJlbl <sarah.diot-girard@owkin.com>
Signed-off-by: SdgJlbl <sarah.diot-girard@owkin.com>
Signed-off-by: SdgJlbl <sarah.diot-girard@owkin.com>
Signed-off-by: SdgJlbl <sarah.diot-girard@owkin.com>
Signed-off-by: SdgJlbl <sarah.diot-girard@owkin.com>
Signed-off-by: SdgJlbl <sarah.diot-girard@owkin.com>
Signed-off-by: SdgJlbl <sarah.diot-girard@owkin.com>
Signed-off-by: SdgJlbl <sarah.diot-girard@owkin.com>
Signed-off-by: SdgJlbl <sarah.diot-girard@owkin.com>
SdgJlbl
force-pushed
the
reorganise-doc
branch
from
9615416
to
00004e2
Compare
Merged
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.
The goal of this PR is to reorganise the documentation according to the Diátaxis framework to facilitate access.
TODO