rolling-scopes / site

🦥🛼 Website supporting The Rolling Scopes and The Rolling Scopes School educational process
https://rollingscopes.com
9 stars 8 forks source link

Set Up README, Developer Documentation, and Colleague Onboarding for FSD project. #322

Open andron13 opened 3 months ago

andron13 commented 3 months ago

📝 Describe the feature

The task encompasses creating a comprehensive README for the project, developing proper documentation for developers, and setting up an onboarding process for new members, all aligned with Feature-Sliced Design (FSD) principles.

ℹ️ Additional context

The README is the face of the project and should provide an overview of the project, including its purpose, key features, and how to get started. Proper documentation facilitates efficient project development and maintenance. Onboarding material, on the other hand, ensures new colleagues can quickly get up to speed with the project.

✅ Definition of Done (DoD):

The task is considered done when the README clearly describes the project and its setup, the developer documentation includes all necessary details for work, and a guide for onboarding new colleagues is in place.