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

Improve docs, examples and tutorial directory #131

Open
leon1995 opened this issue Apr 14, 2023 · 1 comment
Open

Improve docs, examples and tutorial directory #131

leon1995 opened this issue Apr 14, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation v2 Version 2 is affected

Comments

@leon1995
Copy link
Member

leon1995 commented Apr 14, 2023

docs:

  • used for code documentation
  • setup automatic docs generation using sphinx

examples:

  • contains example code implementations. This may can be included directly in the source code

tutorial:

  • implementations of roles, provider, consumer that can be used for demonstration of the package
@leon1995 leon1995 added the documentation Improvements or additions to documentation label Apr 14, 2023
@leon1995 leon1995 added this to the Q2/2023 milestone Apr 14, 2023
@leon1995 leon1995 changed the title Unify docs, examples and tutorial directory Improve docs, examples and tutorial directory May 17, 2023
@leon1995
Copy link
Member Author

currently examples contains the reference tests for the PATs. I suggest to create a new pat folder for those tests

@a-kleinf a-kleinf added the v2 Version 2 is affected label Aug 22, 2023
@leon1995 leon1995 removed this from the v2.0 release milestone Jan 16, 2024
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 v2 Version 2 is affected
Projects
None yet
Development

No branches or pull requests

2 participants