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

Internal documentation and onboarding overhaul #88

Closed
4 tasks done
UZ9 opened this issue Sep 4, 2024 · 1 comment · Fixed by #95
Closed
4 tasks done

Internal documentation and onboarding overhaul #88

UZ9 opened this issue Sep 4, 2024 · 1 comment · Fixed by #95
Assignees

Comments

@UZ9
Copy link
Contributor

UZ9 commented Sep 4, 2024

Context

Juno currently lacks a streamlined way of onboarding new developers, both in understanding the project conceptually and specific documentation for Juno's services. This ticket aims to significantly improve the developer's experience via a refactoring of much of the Juno's documentation.

Tasks

  • Fix Juno README instructions mentioning nonexistent docker compose (it's now split)
  • Add READMEs for all Juno services (instead of the default nest)
  • Collect all of the existing diagrams we have of Juno and modify/add as needed--this will help with streamlining the onboarding process
  • Keep a main overview of how each repository relates to another, as we're currently lacking a bit on this end
@UZ9 UZ9 self-assigned this Sep 4, 2024
@UZ9 UZ9 added this to the Sprint 1 - F24 milestone Sep 5, 2024
@UZ9
Copy link
Contributor Author

UZ9 commented Sep 6, 2024

Docker development moved to a separate ticket (#89)

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 a pull request may close this issue.

1 participant