Work request for this project was submitted to the Graph Advocates DAO by 1Hive. This proposal funds the working hours it take to complete subgraph documentation for total of 5 subgraphs:
- Aragon Connect
- Aragon Agreement
Link to actual docs - Subgraphs - 1Hive
Project Title: Documenting Subgraphs with the Graph Protocol for Improved Transparency and Query Development
We completed subgraphs documentation to improve transparency, accountability, and query development in data analysis. Subgraphs are often used to analyze specific patterns or relationships within the data. However, documenting subgraphs is often overlooked, leading to difficulty in interpreting and communicating the findings.
The proposed project aims to address this gap by creating a framework to document subgraphs using the Graph Protocol, an open-source decentralized protocol for indexing and querying data from blockchain networks. The project will involve the following activities:
- Development of a documentation framework: We will develop a documentation framework that covers important information about your subgraphs, includes links, detailed description of your entities, and query examples.
- Implementation of the framework: We will implement the documentation framework and help get the documentation uploaded to your Gitbook for internal and external developers to review as they use your subgraphs.
- Query development: By documenting subgraphs with the Graph Protocol, we can develop more complex and meaningful queries. The documentation will provide the necessary information for researchers to build queries that can answer specific research questions and generate insights from the data.
By documenting subgraphs with the Graph Protocol, we can improve transparency, accountability, and query development in data analysis, leading to better decision-making and improved trust in the blockchain industry. We believe that this project will contribute to the better understanding and use of your project’s subgraphs.
Paul - Discord PaulieB#0047- Technical Writer
Chidubem - Discord Chidubem#2408 - Technical Writer
Skills and previous experience in related or similar work:
We have worked together and individually on over 20 projects subgraph docs including such projects as: ENS, Sablier, DAOHouse, Polygon and further examples can be provided upon request.
Amount of HNY requested: 130 HNY (~$1,600 at current price) - Revised to 66 HNY ($800 at current price) see below.
Ethereum address where funds shall be transferred: 0x384C460A8bF7D15B48cB062d938E410860647Ef7
More detailed description of how funds will be handled and used:
The funds will be used as payment for work completed do document the five subgraphs the project utilizes with the graph
This proposal pays for 2 Technical Writers working a rate of 4-5 hours on each subgraph for a total of 20-25 hours