WIP : Write documentation #29
Draft
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
Signed-off-by: Joffref <mariusjoffre@gmail.com>
1 task
leorolland
reviewed
Nov 26, 2023
Signed-off-by: Joffref <mariusjoffre@gmail.com>
leorolland
reviewed
Nov 27, 2023
docs/input_cheatsheet.md
Outdated
| @@ -0,0 +1,29 @@ | |||
| # Input Cheatsheet | |||
Collaborator
There was a problem hiding this comment.
I dont know if it's a good idea to add and maintain this page. Everything should be documented in our Go struct definition (avoiding duplicates and a maintainability cost here)
Owner
Author
There was a problem hiding this comment.
I agree with you, thus the struct injected into template has to be in pkg. See #32 for reference.
Owner
Author
|
Resolving typos and your comments as soon as possible! @leorolland |
Seems good to me. Co-authored-by: Léo Rolland <rolland.leo@orange.fr>
Signed-off-by: Joffref <mariusjoffre@gmail.com>
leorolland
approved these changes
Dec 9, 2023
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.