Add some more general information to API docs #160
Conversation
This file contains hidden or 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
Figure out how to not display plugins in the docs
bmeike
approved these changes
Apr 10, 2025
|
|
||
| .. image:: images/architecture.png | ||
| This is the phase in which resources are assembled according to what is needed in the execution phase. Currently in the TDK there are two ways to do this, but the method of doing this is not restrained in any way. The only requirement is that the orchestration phase output a compatible config.json file for the execution phase to use. |
There was a problem hiding this comment.
I know this is picky, but this is a little hard to parse: there are no constraints... except that there only two ways to do it. Maybe something like "TDK orchestration consists of creating a config.json file: any process that does that will work. Currently, there are two such processes implemented"
pasin
approved these changes
Apr 16, 2025
velicuvlad
approved these changes
Jun 3, 2025
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.
No description provided.