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

Write documentation & How to test #71

Open
TheJoin95 opened this issue Oct 15, 2024 · 4 comments
Open

Write documentation & How to test #71

TheJoin95 opened this issue Oct 15, 2024 · 4 comments
Labels
documentation Improvements or additions to documentation

Comments

@TheJoin95
Copy link
Member

TheJoin95 commented Oct 15, 2024

  • Write documentation to how to develop and debug
  • How to test
  • increase the info in the readme
  • add docusaurus (?)
@TheJoin95 TheJoin95 converted this from a draft issue Oct 15, 2024
@TheJoin95
Copy link
Member Author

@LobeTia I've created this issue to speed up the onboarding: do you have any other ideas on how to improve the onboarding for the project?

@Readpato
Copy link
Member

Readpato commented Nov 1, 2024

I think having this implemented could speed up development greatly.

I would gladly give a hand by addressing the README update. I could also tackle the docusarus one, but I think we need to first discuss what's the scope of it

@Readpato Readpato added documentation Improvements or additions to documentation good first issue Good for newcomers and removed good first issue Good for newcomers labels Nov 1, 2024
@TheJoin95
Copy link
Member Author

Maybe it's better to split the two; we should also add E2E tests as well. But, pleas take it both of you like

@Readpato
Copy link
Member

Update, I wont be able to tackle this issue. Leaving it up for grabs for the next contributor that would like to do it :)

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
Status: 🏁 Up Next
Development

No branches or pull requests

2 participants