Appearance
Contributing to our Knowledge Pills
We're excited to have you contribute your knowledge to our AI exploration!
How to contribute
Follow these simple steps to add your own 'knowledge pill' to our website:
Fork the Repository: Start by forking our GitHub repository. This creates a copy of the repository in your GitHub account.
Create a New Branch: Once you have your fork, create a new branch.
Add Your Knowledge Pill: Craft your 'knowledge pill' using Markdown formatting. Create a new Markdown file in the
/docs/pills
directory at the root of the project.Write Your Pill: In the Markdown file, share your insights on a specific AI concept or application. Make it concise and informative, keeping in mind that it should be readable in under 5 minutes.
Commit and Push: After creating and editing the Markdown file, commit your changes to your branch. Then, push your changes to your forked repository on GitHub.
Open a Pull Request: Once your changes are pushed, go to the main repository and open a pull request. We'll review your contribution, provide feedback if needed, and once everything looks great, merge it into the main repository.
Tips for Writing a Great Knowledge Pill:
- Keep it Concise: Focus on a specific AI topic to ensure your pill can be read in under 5 minutes.
- Be Informative: Provide accurate and insightful information about the chosen topic.
- Use Markdown: Familiarize yourself with Markdown formatting to make your pill visually appealing.
- Cite Sources: If you're using external sources, make sure to provide proper attribution.
Thank you for being a part of our AI knowledge-sharing community! Your contribution will help others learn and explore the world of Artificial Intelligence. If you have any questions or need assistance, don't hesitate to reach out.
Happy contributing! 🚀