|Mentor||Nico Hagenburger (hagenburger)|
|Suitable for Beginners?||yes|
|Applications (1st Choice)||5 (4 submitted | 1 in-progress)|
|Applications (2nd Choice)||9 (8 submitted | 1 in-progress)|
|Code of Conduct||https://livingstyleguide.org/code-of-conduct.html|
LivingStyleGuide extends Markdown to improve writing documentation, especially documentation with code examples such as Web Component libraries in Design Systems.
- Faster compilation
- Easy integration into established build systems like Gulp, Grunt, Webpack, …
This process is just in the middle and open for contributions from the Rails Girls community! The development happens in the js branch.
If you are interested in this project and have any project-specific questions, hop into this slack.
“Required” as in please have at least took part in a Rails Girls (or similar) course that covers the topics listed above or have been working on other projects in that area before. You do not need to be an expert; you should have an understanding how those languages in combination can create an interactive website.
Nice to have
- A background/interest in design
- Sass, PostCSS
- Writing skills
- Video creation experience (for tutorials)
- Ruby/Ruby on Rails experience
Not needed at all
- Hardware skills
Tasks And Features
- Extend the documentation for your own code
- Write a beginner’s guide from your perspective getting to know LivingStyleGuide the first time yourself
- Writing plugins (which can separate from the main LivingStyleGuide codebase)
- When you speak other languages than English, translations for the documentation could be a good start
Flexible task planning
The tasks will be planned based on the experience and personal interests of the applicants. Suggestions for new features by the students are very welcomed. The last RGSoC team came up with great ideas during the time.
You must be logged in to comment on this project.
Racheal Mwatela, Wednesday, February 28, 07:02 UTC
yati1998, Thursday, February 15, 09:54 UTC
Ananya Singh, Thursday, February 8, 18:15 UTC
In my personal opinion the current way of documentation is quite uninteresting and we should make it more user friendly. We have some ideas on how to improve this. Please tell us more about your project. Awaiting your reply.
Paarmita Bhargava, Thursday, February 8, 14:05 UTC
Hi! Saloni and I love to work on projects.We have experience with Ruby on Rails and are familiar with the codebase and application development.We also have appreciable knowledge in HTML, CSS, JS, Bootstrap(front end, git, and documentation.We are currently learning React.We are interested in learning new skills and this project gives us that opportunity.
Please guide us on how we can contribute to the same. :)
Parul Aggarwal, Monday, February 5, 11:21 UTC
My partner Sneha and I loved the concept of your project LivingStyleGuide. Please guide us on how we can contribute to the same. Also it would be great if we could continue the further communication through any medium of your choice. We are looking forward to hear from your side to begin with our contributions. :D