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

add docs #169

Merged
merged 1 commit into from
Jan 21, 2025
Merged

add docs #169

merged 1 commit into from
Jan 21, 2025

Conversation

js3110
Copy link
Collaborator

@js3110 js3110 commented Jan 20, 2025

Issue

Closes #164

@js3110 js3110 linked an issue Jan 20, 2025 that may be closed by this pull request
Copy link
Collaborator

@m-kolomanski m-kolomanski left a comment

Choose a reason for hiding this comment

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

LGTM, thank you!

Copy link
Collaborator

@Gero1999 Gero1999 left a comment

Choose a reason for hiding this comment

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

Hey @js3110 thanks for this, looks good!

Only thing is that it would be good if the source document is also here, even if the link in our README only leads to the pdf. That way whenever there are relevant modifications in the workflow we all can easily change it!

@m-kolomanski
Copy link
Collaborator

@Gero1999 It depends. Do we want to commit to maintaining this document for a longer period of time? The alternative would be to mark this solution as just a temporary measure, and when we have more important stuff out of the way, we could use this doc to write some complete documentation, on github pages and whatnot.

Depends if we consider this a temporary solution or a temporary solution ¯_(ツ)_/¯ Both are fine, I am just adding my two cents to consider.

Copy link
Collaborator

@Gero1999 Gero1999 left a comment

Choose a reason for hiding this comment

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

@m-kolomanski this is just a temporary solution until the github pages is well deployed. then we can put a good tutorial/manual instructions in there

So I will approve directly @js3110 , good work!

@js3110 js3110 merged commit b97559b into main Jan 21, 2025
9 checks passed
@m-kolomanski m-kolomanski deleted the documentation/add-instruction-manual branch January 30, 2025 07:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation: Add instruction manual
3 participants