Feat/add onboarding documentation#99
Feat/add onboarding documentation#99omckeon merged 6 commits intothoth-tech:mainfrom Liquidscroll:feat/add-onboarding-documentation
Conversation
✅ Deploy Preview for strong-fairy-c1bde1 ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
✅ Deploy Preview for thoth-tech ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
There was a problem hiding this comment.
The SplashKit Get to Know Us page is well organised, with clear sections that provide a logical flow of information. The use of sidebars, cards, and callouts helps break down what could be an overwhelming amount of content for a new joiner, making it easier to digest. I especially like the TL;DR sections – they align well with what an average student is likely to focus on. The emphasis on practical contributions should help students understand their impact. Minor recommendations for the page:
- 'Propogate' (under 'SplashKit Translator') should be spelled as 'propagate.'
- Given the volume of information, consider adding a navigation or contents element at the top of the page to help students quickly reach the sections they find most important – a TL;DR of the TL;DR.
The SplashKit Expansion Peer Review Guide provides an excellent framework for students to conduct thorough and meaningful peer reviews. The clear steps and prompts that ensure consistency across the project should significantly improve the review process. I particularly appreciate how the guide emphasises collaboration – a reminder for students to avoid becoming defensive about critiques of their work. My only recommendation would be to standardise the capitalisation of 'SplashKit' throughout the document for consistency.
The SplashKit Onboarding Guide does a great job outlining the trimester workflow. Each step is well defined, making it easy for students to understand expectations. I like how the guide balances technical instructions with the importance of collaboration, especially during peer review, where the focus on discussion helps set the right tone for constructive feedback. The workflow component sets clear expectations, helping new contributors feel confident about where they fit into the process. One absolutely minor point is on line 38, in the step "Peer Review," change "in the form a discussion" to "in the form of a discussion".
Overall, these documents are well structured and effectively guide new students through the stressful onboarding process, and will provide a solid foundation for onboarding and contribution. I have tested all links as well, and they all point to the expected locations.
|
Thanks for the really in depth review! I've fixed the typos and the phrasing in the Peer Review step of the Onboarding document. I have not created a table of contents, as I feel that it'll conflict with the inbuilt table of contents. Instead, I've increased the max heading depth so the inbuilt table of contents now includes links to each specific project section, see: |
That looks good. Thanks for the changes! |
3 participants
Description
This Pull Request adds three new documentation files for the SplashKit project. These files are aimed at providing essential onboarding guides, peer-review processes, and an overview of SplashKit’s features and repositories. The goal is to improve the onboarding experience for new contributors and clarify the peer-review process to ensure consistent code quality and collaboration within the project.
Type of change
How Has This Been Tested?
These changes are documentation-only, and no code changes were made. The documentation was reviewed locally in the Astro Starlight environment to ensure proper formatting.
Testing Checklist
Checklist