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

As a user, I want the README to properly introduce this component of Fertiscan and give me enough information to get started on development of the backend. #5

Closed
4 of 5 tasks
SamuelPelletierEvraire opened this issue May 16, 2024 · 0 comments · Fixed by #77
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@SamuelPelletierEvraire
Copy link
Contributor

SamuelPelletierEvraire commented May 16, 2024

Fertiscan Backend Component Onboarding Process

Tasks:

  • Update README to provide a clear introduction to the backend component of Fertiscan.
  • Include detailed setup instructions for the development environment.
  • Describe the overall architecture and key components of the backend.
  • Add a section for common troubleshooting tips and FAQs.
  • Provide links to relevant documentation and resources.

Acceptance Criteria:

  • The README should equip the developer with the skills necessary to work within the AI LAB's framework.
  • The README should give enough information for the developer to get started on backend development.
@SamuelPelletierEvraire SamuelPelletierEvraire changed the title Documentation of fertiscan backend Documentation of fertiscan homepage backend May 16, 2024
@Endlessflow Endlessflow changed the title Documentation of fertiscan homepage backend As a user, I want the README to properly introduce this component of Fertiscan and give me enough information to get started on development of the backend. Jun 28, 2024
@Endlessflow Endlessflow added the documentation Improvements or additions to documentation label Jul 3, 2024
@Endlessflow Endlessflow assigned snakedye and unassigned Endlessflow Jul 8, 2024
snakedye added a commit that referenced this issue Jul 9, 2024
Issue #5: More descriptive README
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: Done
Development

Successfully merging a pull request may close this issue.

3 participants