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 general app documentation #103

Open
3 tasks
jpwahle opened this issue Sep 4, 2022 · 1 comment
Open
3 tasks

Add general app documentation #103

jpwahle opened this issue Sep 4, 2022 · 1 comment

Comments

@jpwahle
Copy link
Owner

jpwahle commented Sep 4, 2022

Is your feature request related to a problem? Please describe.
Each repository has API documentation (e.g., backend, prediction-endpoint). To get users started more general, we should have general documentation and link it to the main repo's readme.
The docs should be here and also linked to the cs-insihgts-main repo.

Describe the solution you'd like

  • Write general docs. Also, link technical documentation of each project whenever appropriate.
  • Link to frontend whenever we have a "documentation" link.
  • Link documentation in cs-insights-main readme.
@jpwahle jpwahle moved this to 🆕 New in cs-insights Oct 17, 2022
@jpwahle jpwahle moved this from 🆕 New to 📋 Backlog in cs-insights Nov 3, 2022
@jpwahle jpwahle changed the title Add general documentation Add app documentation Sep 18, 2023
@jpwahle jpwahle moved this from 📋 Backlog to 🆕 New in cs-insights Sep 18, 2023
@jpwahle jpwahle moved this from 🆕 New to 📋 Backlog in cs-insights Sep 18, 2023
@jpwahle
Copy link
Owner Author

jpwahle commented Sep 18, 2023

Although very important, I will move this towards the end of the advanced research project from @muhammadtalha242 to avoid double work and having to adjust the docs many times.

@jpwahle jpwahle changed the title Add app documentation Add generalapp documentation Sep 25, 2023
@jpwahle jpwahle changed the title Add generalapp documentation Add general app documentation Sep 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: 📋 Backlog
Development

No branches or pull requests

1 participant