-
Notifications
You must be signed in to change notification settings - Fork 175
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
We are excited to add docIT document chat to EOS discord or any sources needed. minor app updates
- Loading branch information
1 parent
e455b6b
commit 711e64a
Showing
1 changed file
with
122 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,122 @@ | ||
| # EOS Network Foundation Grant Proposal | ||
|
|
||
| - **Project Name:** EOS Documentation Discord Bot | ||
| - **Team Name:** EOS Docs Team | ||
| - **EOS Payment Address:** coinbasebase | memo: 4132734636 | ||
| - **[Level](https://github.com/eosnetworkfoundation/grant-framework#grant-levels):** 2 | ||
| - **Pomelo Grant(s):** N/A | ||
| - **Project is Open-Source:** Yes | ||
| - **Project was part of Token sale:** No | ||
| - **Repository where Project resides:** https://github.com/eosdocsteam/eosdocbot | ||
|
|
||
| ## Contact | ||
|
|
||
| - **Contact Name:** Nigel Alford | ||
| - **Contact Email:** ngalford@gmail.com | ||
| - **Website:** https://eosdocbot.com | ||
|
|
||
| ## Project Overview | ||
|
|
||
| ### Overview | ||
|
|
||
| - **Name:** EOS Documentation Bot: "Talk to Your Docs" | ||
| - **Brief Description:** A state-of-the-art Discord bot for EOS, leveraging the latest Large Language Models (LLMs) to allow users to "talk to docs" by querying EOS's Github repositories, documentation, and related articles. | ||
| - **Relationship to EOS Network / Antelope:** The bot serves as a bridge between EOS's existing documentation and its community, offering a streamlined support mechanism within the EOS ecosystem. | ||
| - **Reason for Interest:** Our passion lies in enhancing user experience and engagement within the EOS network. We see a gap in immediate, efficient support, and our bot aims to bridge this. | ||
|
|
||
| ### Project Details | ||
|
|
||
| - Mock-ups/designs of any UI components: Designs available upon request. | ||
| - Data models of the core functionality: Integrating LLMs with EOS's existing documentation structure. | ||
| - API specifications of the core functionality: Using OpenAI's API combined with EOS's internal APIs. | ||
| - An overview of the technology stack to be used: OpenAI, Digital Ocean (Hosting), Supabase. | ||
| - Documentation of core components: Available in our GitHub repository. | ||
| - PoC/MVP or other relevant prior work: Prototype bot with limited functionalities available for demonstration. | ||
| - What your project is _not_ or will _not_ provide: The bot will not provide real-time human support or handle transactions. | ||
|
|
||
| ### Ecosystem Fit | ||
|
|
||
| - **Where and how does your project fit into the ecosystem?** Our bot streamlines the support process within the EOS ecosystem, offering immediate answers to frequent queries. | ||
| - **Who is your target audience?** EOS developers, community members, and new users. | ||
| - **What need(s) does your project meet?** Instantaneous support, reduced manual support hours, and enhanced user experience. | ||
| - **Are there any other projects similar to yours in the EOS Network / Antelope ecosystem?** No known direct competitors. Our solution is unique in its integration of LLMs and EOS's documentation. | ||
|
|
||
| ## Team | ||
|
|
||
| ### Team members | ||
|
|
||
| - **Owner and Developer:** Nigel Alford | ||
|
|
||
| ### Legal Structure | ||
|
|
||
| - **Registered Legal Entity:** Independent Developer | ||
|
|
||
| ### Team Experience | ||
|
|
||
| Nigel Alford, our team leader, has spearheaded numerous decentralized solutions, including a notable NFT marketplace. Our team has been deeply involved in several technical projects, reflecting our commitment to minimizing technical barriers. | ||
|
|
||
| ### Team Org Repos | ||
|
|
||
| - [Website](https://docit.cc) | ||
| - https://github.com/mrnigelalford/docit-discord | ||
|
|
||
| ### Team Member Repos | ||
|
|
||
| - https://github.com/mrnigelalford | ||
|
|
||
| ### Team LinkedIn Profiles | ||
|
|
||
| - https://www.linkedin.com/in/nigelalford | ||
|
|
||
| ## Development Status | ||
|
|
||
| Our bot's prototype is available for demonstration. It's a culmination of extensive research and development, as seen in our GitHub issues, forum discussions, and internal team meetings. Links to relevant research and documentation are available in our repository. | ||
|
|
||
| ## Development Roadmap | ||
|
|
||
| - **Total Estimated Duration:** 2 months | ||
| - **Full-Time Equivalent (FTE):** 2 FTE | ||
| - **Total Costs:** 8,000 USD | ||
|
|
||
| ### Pre-Implementation: Team Collaboration | ||
|
|
||
| - **Estimated Duration:** 1 week | ||
|
|
||
| | ID | Deliverable | Specification | | ||
| | --- | ----------- | ------------- | | ||
| | 0a. | Collaboration | Engage with the DevRel, Customer Support, and Community Support teams to understand their needs and pain points. | | ||
| | 0b. | Needs Assessment | Identify areas where the bot or widget can be most beneficial based on team feedback. | | ||
| | 0c. | Data Source Selection | Based on insights, select the most appropriate data sources for implementation. | | ||
|
|
||
| ### Milestone 1: Implementation of Data Sources | ||
|
|
||
| - **Estimated Duration:** 2 weeks | ||
|
|
||
| | ID | Deliverable | Specification | | ||
| | --- | ----------- | ------------- | | ||
| | 1a. | Data Source Integration | Incorporate 3-4 high-value data sources into the bot or widget. | | ||
| | 1b. | Data Crawling | Crawl relevant data from the selected data sources. | | ||
| | 1c. | OpenAI Embeddings | Create OpenAI embeddings in our database for quick search on queries. | | ||
| | 1d. | Index Creation | Develop and refine the index creation process for the crawled data. | | ||
| | 1e. | End State | 3-4 fully integrated data sources that can be queried. | | ||
| | 1f. | Expected Bugs | Identify potential issues such as hallucinations or mismatches between query and documents. | | ||
|
|
||
| ### Milestone 2: Testing, Optimization, and Deployment | ||
|
|
||
| - **Estimated Duration:** 2 weeks | ||
|
|
||
| | ID | Deliverable | Specification | | ||
| | --- | ----------- | ------------- | | ||
| | 2a. | Bug Elimination | Focus on eliminating identified bugs, especially hallucinations. | | ||
| | 2b. | Prompt Engineering | Refine the prompting mechanism to ensure relevant and accurate answers. | | ||
| | 2c. | Source Material Links | Ensure that each answer provided is accompanied by a link to the source material for user verification. | | ||
| | 2d. | End State | Achieve a production-ready bot or widget approved by the Customer / Community Support teams. | | ||
| | 2e. | Deployment | Ensure the bot or widget is ready for deployment on the Optimisim's Discord page or any other desired platform. | | ||
|
|
||
| ## Future Plans | ||
|
|
||
| Post-deployment, we plan to gather user feedback to refine our bot further. We're committed to continuous updates, community engagement, and potential expansion to other platforms beyond Discord. In the long run, we envision our bot serving multiple blockchains and becoming a go-to tool for instant documentation-related support. | ||
|
|
||
| ## Additional Information | ||
|
|
||
| **How did you hear about the Grants Program?** EOS Network Foundation Website. |