-
Notifications
You must be signed in to change notification settings - Fork 68
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
[Feature] Addition of a guides folder for beginner to this project #210
Comments
@egbadon-victor (and others) please provide more information on what specific guides you think would be helpful (that are not already covered by the guides on Creative Commons Open Source |
Okay @TimidRobot Things we could include in the guide would be very specific to legaldb. Going through the Creative Commons Open Source, the only reference to legaldb is a link to the repo here on github. Hence the aim of the guides would be a hands on, quick setup guide covered in detail, especially helpful for beginners or new contributors. Here are examples of specific guides;
Most of these suggestions are tailored to beginners, and I think that is the basic essence. More advanced contributors are familiar with project structure in general, and often know where to search solutions if they have any problems. |
@egbadon-victor of the examples provided, I think Simple explanation on the technologies used in the repo, how it is being used, and where contributors can get official help (more like our recommendation) has value. I would like to avoid generic documentation in this project repository. Instead, the project documentation should reference things like Foundational technologies — Creative Commons Open Source. |
@TimidRobot this is noted. I would get to work on a sample, send a draft PR, and then get your opinions on what would be considered generic documentation. |
Problem
Beginners to the
creativecommons/legaldb
project may find it difficult to understand the legaldb project structure, and even set it up. While theREADME
file can be improved, I think beginners would benefit from more explicit instructions and explanations.Description
Inspired by the guides folder in the creativecommons/search repository, implementing a
guides/
folder would help new contributors get acquainted with the project, and provide valuable tutorials on the basic interactions on this project.Alternatives
README
file more explicit as captured in Enhancement: Make env template and README more explicit #202 . This would make theREADME
a bit too much for someone who is already familiar and just wants to get going.Implementation
The text was updated successfully, but these errors were encountered: