📝(project) add base documentation #60
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
jmaupetit
commented
Feb 12, 2021
jmaupetit
force-pushed
the
add-docs
branch
4 times, most recently
from
95aaf52
to
c88f8a0
Compare
SergioSim
reviewed
Feb 24, 2021
|
Thank you for your feedback @SergioSim ❤️ |
There was a problem hiding this comment.
Congrats for this comprehensive work!
There is still a very very small issue that comes from the automated update for command and model documentations:
- sometimes, there is the description sentence with a point (for example in Open edx events > base > baseContextModel)
Represents the base context model inherited by all event contexts.
- and sometimes not (for example in ralph > extract)
Extract input events from a container format using a dedicated parser
You are totally right, we need to stay consistent. IMO this should be addressed in a new PR. |
|
@SergioSim & @quitterie-lcs I've addressed all your comments in separated fixup commits. Is there any chance that you have time for a last review (and validation)? 🙏 |
Now that the project is used in production, we need to explain key concepts and document commands and backends.
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.
Purpose
Now that the project is used in production, we need to explain key concepts and document commands and backends.
Proposal
write tutorialpostponed (will be handled in another PR)