Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WIP : Write documentation #29

Draft
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

Joffref
Copy link
Owner

@Joffref Joffref commented Nov 24, 2023

No description provided.

@Joffref Joffref linked an issue Nov 24, 2023 that may be closed by this pull request
1 task
@Joffref Joffref self-assigned this Nov 24, 2023
@Joffref Joffref added the documentation Improvements or additions to documentation label Nov 24, 2023
@Joffref Joffref added this to the MVP milestone Nov 24, 2023
Signed-off-by: Joffref <[email protected]>
@Joffref Joffref requested a review from leorolland November 27, 2023 07:59
docs/README.md Outdated Show resolved Hide resolved
docs/README.md Outdated Show resolved Hide resolved
docs/how_to_write_template.md Outdated Show resolved Hide resolved
@@ -0,0 +1,29 @@
# Input Cheatsheet
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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)

Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree with you, thus the struct injected into template has to be in pkg. See #32 for reference.

docs/testing.md Outdated Show resolved Hide resolved
docs/testing.md Outdated Show resolved Hide resolved
docs/testing.md Show resolved Hide resolved
@Joffref
Copy link
Owner Author

Joffref commented Nov 28, 2023

Resolving typos and your comments as soon as possible! @leorolland

Seems good to me.

Co-authored-by: Léo Rolland <[email protected]>
@Joffref Joffref requested a review from leorolland December 8, 2023 19:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Enhancement]: Document exposed attributes to template
2 participants