Funding Proposal - Subgraph Documentation

🌿 Proposals
#1

Proposal Information

Proposal description:
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
  • Celeste
  • Gardens
  • Honeyswap

Link to actual docs - Subgraphs - 1Hive

Vote to fund proposal here

Project Title: Documenting Subgraphs with the Graph Protocol for Improved Transparency and Query Development

Project Overview:

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:

  1. 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.
  2. 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.
  3. 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.

Conclusion:

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.

Team Information (For Funding Proposals)

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.

Funding Information (For Funding Proposals)

Amount of HNY requested: 130 HNY (~$1,600 at current price)

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 and a pay rate of $64-$80 per hour.

1 Like
#2

While I appreciate the effort and importance of documenting subgraphs for improved transparency and query development, it’s difficult for me to support this funding proposal for the following reasons:

  1. Cost per hour: The requested pay rate of $64-$80 per hour appears to be on the higher side, especially when taking into account the available funds within 1Hive. Furthermore, many of us who work here do not receive rates close to the proposed rate.
  2. Priority: This service could potentially increase GRT consumption, which would again affect 1Hive’s funding. I believe we should prioritize funding for projects that provide clear value. I could be mistaken on this point, but it’s how I currently see the priorities within 1Hive.
  3. Misunderstanding about team affiliation: I initially assumed that you were part of TheGraph’s team. If I had known beforehand that this would be a separate service, I would have raised the same concerns mentioned here.

Note: I understand that the documentation has already been completed, but access to the GitBook is restricted, preventing the community from evaluating the quality and relevance of the work. Additionally, there is insufficient proof of past experience, as the proposal does not provide specific examples or links to previous work.

This is only my personal opinion, and it reflects how I perceive the current priorities within 1Hive. Please feel free to discuss further if you have alternative perspectives or suggestions.

4 Likes
#3

Thank you for considering our proposal. I want to clarify that the subgraph documentation request was not solicited but rather submitted by 1Hive through the Graph Advocates DAO subgraph docs request process, not directly to The Graph. I apologize for any confusion on this matter.

Subgraph documentation provides significant value by clearly explaining the purpose and functionality of the subgraph. It also makes the subgraph easier to use and maintain, facilitates collaboration among developers, and builds a community around the subgraph. Well-written documentation can ensure the subgraph’s longevity by providing information on its design and dependencies, and by making it more accessible and understandable to developers interested in using or contributing to it.

Regarding the cost of subgraph documentation, I’d like to clarify that the standard price for this service is typically $350 per subgraph. However, due to the submission of five requests, we were able to use a lower rate of $320 per subgraph due to the complexity and research it takes to review each protocol. Before commencing the task, we discussed pricing through Discord with a team member and agreed that $1,600 was a feasible amount. However, we would require a funding proposal, and it is possible that 50% of the payment would be made in locked HNY tokens. If this is not feasible, we are open to exploring other options that work for both parties.

On the funding submission form, I was only able to include two links. For previous work completed, you can find examples in this article (Subgraph Documentation — How to document your subgraph using the Graph Advocates | by paulieb.eth | Medium).

Thank you for your time and consideration, and please let us know if you need any further information. I can provide links to our Github pull request (below) to view the work. The team should be able to view the docs on the link on the initial proposal. The forum only allows me to enter two links in each forum entry.