diff --git a/HACKTOBERFEST.md b/HACKTOBERFEST.md new file mode 100644 index 0000000..e6486ae --- /dev/null +++ b/HACKTOBERFEST.md @@ -0,0 +1,31 @@ +πŸŽ‰ Join the Hacktoberfest with DocsGPT and Earn a Free T-shirt! πŸŽ‰ + +Welcome, contributors! We're excited to announce that DocsGPT is participating in Hacktoberfest. Get involved by submitting a **meaningful** pull request, and earn a free shirt in return! +πŸ“œ Here's How to Contribute: + + πŸ› οΈ Code: This is the golden ticket! Make meaningful contributions through PRs. + πŸ“š Wiki: Improve our documentation, Create a guide or change existing documentation. + πŸ–₯️ Design: Improve the UI/UX, or design a new feature. + +πŸ“ Guidelines for Pull Requests: + +Familiarize yourself with the current contributions and our [Roadmap](https://github.com/orgs/arc53/projects/2). + +Deciding to contribute with code? Here are some insights based on the area of your interest: + +Frontend (βš›οΈReact, Vite): + Most of the code is located in /frontend folder. You can also check out our React extension in /extensions/react-widget. + For design references, here's the [Figma](https://www.figma.com/file/OXLtrl1EAy885to6S69554/DocsGPT?node-id=0%3A1&t=hjWVuxRg9yi5YkJ9-1). + Ensure you adhere to the established guidelines. + +Backend (🐍Python): + Focus on /application or /scripts. However, avoid the files ingest_rst.py and ingest_rst_sphinx.py as they are soon to be deprecated. + Newly added code should come with relevant unit tests (pytest). + Refer to the /tests folder for test suites. + +Check out [Contributing Guidelines](https://github.com/arc53/DocsGPT/blob/main/CONTRIBUTING.md) + + +Don't be shy! Hop into our [Discord](https://discord.gg/n5BX8dh8rU) Server. We're a friendly bunch and eager to assist newcomers. + +Big thanks for considering contributing to DocsGPT during Hacktoberfest! πŸ™ Your effort can earn you a swanky new t-shirt. 🎁 Let's code together! πŸš€ \ No newline at end of file diff --git a/README.md b/README.md index 3371d8f..54e46d8 100644 --- a/README.md +++ b/README.md @@ -27,6 +27,8 @@ Say goodbye to time-consuming manual searches, and let DocsGPT When deploying your DocsGPT to a live environment, we're eager to provide personalized assistance. Reach out to us via email [here]( mailto:contact@arc53.com?subject=DocsGPT%20Enterprise&body=Hi%20we%20are%20%3CCompany%20name%3E%20and%20we%20want%20to%20build%20%3CSolution%3E%20with%20DocsGPT) to discuss your project further, and our team will connect with you shortly. +### [πŸŽ‰ Join the Hacktoberfest with DocsGPT and Earn a Free T-shirt! πŸŽ‰](https://github.com/arc53/DocsGPT/blob/main/HACKTOBERFEST.md) + ![video-example-of-docs-gpt](https://d3dg1063dc54p9.cloudfront.net/videos/demov3.gif) diff --git a/docs/pages/index.mdx b/docs/pages/index.mdx index 0ce260c..b7fe172 100644 --- a/docs/pages/index.mdx +++ b/docs/pages/index.mdx @@ -21,6 +21,9 @@ export const allGuides = { DocsGPT πŸ¦– is an innovative open-source tool designed to simplify the retrieval of information from project documentation using advanced GPT models πŸ€–. Eliminate lengthy manual searches πŸ” and enhance your documentation experience with DocsGPT, and consider contributing to its AI-powered future πŸš€. +Our demo: [https://docsgpt.arc53.com/](https://docsgpt.arc53.com/) + +Want to earn a cool shirt by submitting a **meaningful** PR, check out [Hacktoberfest](https://github.com/arc53/DocsGPT/blob/main/HACKTOBERFEST.md) guide.