Some clarity and language improvements #16
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
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.
Some things we can add:
It could be nice to have one-sentence explanation of what exactly "services" are here. For example, section "Extend the service", how is the SaleService used by ShopInvader (does it automatically create a controller route? Or is it meant to be used inside a controller route? or are services unrelated to shopinvader and only used inside odoo?). The whole Component stack can be intimidating at first because of all the different notions, so a brief high-level explanation will help there.
Section "Modify addresses webservice (read/write information)"
Is there a difference between a webservice and a service ?
Example code for every step and a final example module would be great.edit: noticed there was source availableIt would also be good to have a final recap of what we added, how it's going to be used by ShopInvader, what will LocomotiveCMS see and the impact on the final frontend site. This would give more context for easier understanding for Shopinvader noobs who are familiar with Odoo.
I will help with all that as I understand it better, and it will be faster if someone spends some of their patience to explain it to me on the phone :)