Last updated 5 months ago
"Knock knock..." "Who's there?" "Good Cardano documentation" "...Who?!" Cardano needs well-organized, complete and accurate technical documentation for core development efforts impacting stake pools.
The CoinCashew Guide will 1) Update documentation to reflect ongoing core development efforts, 2) Improve overall content presentation and quality, and 3) Procure a new required Web hosting solution.
Please provide your proposal title
CoinCashew Guide - Core Development and Web Hosting Updates
Enter the amount of funding you are requesting in ADA
60000
Please specify how many months you expect your project to last
6
Please indicate if your proposal has been auto-translated
No
Original Language
en
What is the problem you want to solve?
"Knock knock..." "Who's there?" "Good Cardano documentation" "...Who?!" Cardano needs well-organized, complete and accurate technical documentation for core development efforts impacting stake pools.
Supporting links
Does your project have any dependencies on other organizations, technical or otherwise?
Yes
Describe any dependencies or write 'No dependencies'
CoinCashew Guide content depends on Cardano core development efforts.
Will your project's outputs be fully open source?
Yes
Please provide details on the intellectual property (IP) status of your project outputs, including whether they will be released as open source or retained under another licence.
One of the first resources available online to support Cardano stake pool operations, since 2021 the How to Set Up a Cardano Stake Pool guide presented by CoinCashew has been a community-led open source project.
Please choose the most relevant theme and tag related to the outcomes of your proposal
Education
Who you’re targeting, how you’ll reach them, and why this matters for Cardano?
Available since 2021 and one of the first resources available online to support Cardano stake pool operations, the How to Set Up a Cardano Stake Pool guide provides open source educational content that continues to play an essential role in welcoming newcomers to the Cardano ecosystem while also serving as a valuable resource for experienced Cardano community members.
The Guide offers complete, accurate and up-to-date information and step-by-step procedures on topics related to operating the Cardano Node and supporting software in practical, real-world stake pool configurations. The Guide also explains in detail how to upgrade Cardano Node software.
Supporting stake pool operation matters for Cardano because the ecosystem requires stake pools.
Provide a list of key activities of your project:
What are your success metrics?
The following metrics are designed to measure the success of the current proposal:
Please describe your proposed solution and how it addresses the problem
Available as a community-led project since 2021 and one of the first resources available online to support Cardano stake pool operations, the How to Set Up a Cardano Stake Pool guide presented by CoinCashew at https://www.coincashew.com/coins/overview-ada/guide-how-to-build-a-haskell-stakepool-node is an Installation and Administration guide aimed for an audience of users requiring a level of technical expertise include using the Linux command line, compiling binaries, bash scripting and setting up secure networking capabilities.
The current proposal aims to:
Please define the positive impact your project will have on the wider Cardano community
The current proposal aims to continue ensuring maintenance of the How to Set Up a Cardano Stake Pool guide presented by CoinCashew to offer the best available documentation for stake pool operators.
What is your capability to deliver your project with high levels of trust and accountability? How do you intend to validate if your approach is feasible?
While continuing to provide open source documentation based on any and all community input in the form of content development and review as well as financial donations, since 2022 the CoinCashew Guide operates in collaboration with Change Pool (Ticker CHG, https://coincashew.io). CHG Pool offers professional technical writing based on more than 15 years of IT industry experience to take responsibility for bridging any gaps in content, ensuring that the CoinCashew Guide remains up to date and accurate for newcomers to the Cardano ecosystem as well as experienced community members. In the past three years, CHG Pool has submitted more than 25 pull requests for the CoinCashew Guide at https://github.com/coincashew/coincashew
CHG Pool was created in 2021 using the CoinCashew Guide. Proceeds that CHG Pool receives for playing a role in securing the documentation of the Cardano network proportionally support CoinCashew and other socially responsible not-for-profit organizations.
Milestone Title
Procuring Hardware and Services
Milestone Outputs
Acceptance Criteria
Evidence of Completion
Delivery Month
1
Cost
10000
Progress
20 %
Milestone Title
Improving Styles and Standards
Milestone Outputs
Acceptance Criteria
Evidence of Completion
Delivery Month
2
Cost
10000
Progress
30 %
Milestone Title
End-to-end Testing of Existing Content
Milestone Outputs
Acceptance Criteria
Evidence of Completion
Delivery Month
4
Cost
20000
Progress
60 %
Milestone Title
Developing New Content
Milestone Outputs
Develop new content to support new and existing stake pool operators to implement and use the following current features affecting stake pool operation:
Acceptance Criteria
In addition to existing content, the CoinCashew Guide must support core development efforts pertaining to stake pool operation including but not limited to:
Evidence of Completion
The CoinCashew Guide includes up-to-date content supporting implementation and administration of:
Delivery Month
5
Cost
10000
Progress
80 %
Milestone Title
Reviewing and Publishing Content
Milestone Outputs
Acceptance Criteria
Evidence of Completion
Delivery Month
6
Cost
10000
Progress
100 %
Please provide a cost breakdown of the proposed work and resources
In summary, the proposal allocates funding for completed project milestones as follows:
How does the cost of the project represent value for the Cardano ecosystem?
As a critical component of managing and maintaining IT infrastructure, documentation helps with:
In addition to completing significant improvements to the overall presentation, layout and open source workflow of the CoinCashew Guide as well as significant updates to existing content reflecting ongoing core development efforts, the current proposal aims to offer the best available documentation for new and existing stake pool operators.
I confirm that the proposal is a non-technical initiative, with ≤20% of the budget for tech support.
Yes
I confirm that the proposal provides verifiable evidence (portfolio, links, reports) of the team's ability to deliver the project.
Yes
I confirm that the proposer and all team members are in good standing with prior Catalyst projects.
Yes
I confirm that the proposal includes clear objectives with both Output Metrics (what proposal did) and Adoption-Focused Metrics (what effect proposal had).
Yes
I confirm that the proposal clearly explains the user journey and provides a credible plan for how the project will equip and motivate users for future on-chain activity.
Yes
I confirm that the initiative clearly demonstrates how it will grow the Cardano ecosystem or onboard users.
Yes
I confirm that the project plan and timeline (≤ 12 months) are realistic and well-defined.
Yes
I confirm that the proposal commits to public outputs and justifies any exceptions.
Yes
I confirm that the budget adheres to all policies: it is for future work, follows the merchandise rule, and excludes establishing local treasuries, incentives/giveaways, re-grants.
Yes
I Agree
Yes
Since 2021, CoinCashew.com hosts your source of technical information for Cardano stake pool operation.
In addition to operating a growing Cardano stake pool successfully on Mainnet for the past four years; serving as the main contributor to the CoinCashew Guide for the past three years; completing the Cardano Haskell Developer Course delivered by EMURGO Academy in 2023; and, participating in Cardano Constitutional Workshops in 2024, CHG Pool (CoinCashew.io) offers more than 15 years of IT industry experience in technical writing and instructional design with expertise in business analysis.