CardanoPress: Docs for the Builders
Problem
Not everyone is an experienced developer that can pick up code to start building, but we are seeing more projects entering the space at this level of experience. Docs and tutorials will help!
Solution
CardanoPress is a brilliant tool for projects to build DApps but requires more documentation and tutorials. We want to create more documentation to help people start building Cardano-powered websites.
Total to date
This is the total amount allocated to CardanoPress: Docs for the Builders.
About this idea
[IMPACT] Please describe your proposed solution.
We are targetting, in particular, users and projects that want to build on Cardano but have almost no development skills to implement their solutions. CardanoPress bridges this gap immensely and documentation to guide the users through the process will see more use the plugin along with use of Cardano.
We have partial documentation to help new users install and configure the CardanoPress plugin as of now but more is required to explain its functionality and examples of implementing the various features for Cardano-based projects.
Our current documentation and knowledge base can be found on our website:
https://cardanopress.io/docs/
Creating more details instructions on how to implement all the features and various use cases is required to help users implement and customise their solutions.
A competent WordPress developer would be able to build and extend all that we have created with the limited documentation we have provided, but many don't know what WordPress is, nor do they know where to start.
This set of documentation will take any user from a novice to a competent builder with the CardanoPress plugin.
[IMPACT] Please describe how your proposed solution will address the Challenge that you have submitted it in.
Providing documentation and instructions for users will help them implement their projects.
As a development tool for builders, we'll see more NFT projects, stake pool operators and other projects building on Cardano take up the plugin to create innovative websites around the Cardano blockchain.
We want our documentation to make it as easy as possible for anyone to pick up our plugin and start building.
[IMPACT] What are the main risks that could prevent you from delivering the project successfully and please explain how you will mitigate each risk?
Ideally, we should be creating the documentation based on the stable version of the core plugins and themes. Currently, the core plugin is still in BETA.
Creating documentation against the BETA version will require rework to keep them up to date.
To help mitigate the risk of excessive work, it may be best to complete the documentation fully after the stable version of the plugin is released.
[FEASIBILITY] Please provide a detailed plan, including timeline and key milestones for delivering your proposal.
Phase 1: Outline the documentation and what is required to be documented
Phase 2: Write the draft of the documentation
Phase 3: Open documentation to testing and community feedback
Phase 4: Create videos to accompany the documentation
Phase 5: Publish the final versions of the documentation on the CardanoPress.io website and GitHub
[FEASIBILITY] Please provide a detailed budget breakdown.
60 hours of content writing and video production at the team's hourly rate of $150 an hour.
8 hours - Documentation outline and structure
36 hours - Writing, revisions & community feedback
16 hours - Video production
[FEASIBILITY] Please provide details of the people who will work on the project.
Peter Bui - Creator of CardanoPress & host of the Learn Cardano Podcast
Peter will be writing all of the documentation and creating the examples for users to follow and learn from.
[FEASIBILITY] If you are funded, will you return to Catalyst in a later round for further funding? Please explain why / why not.
We'll likely return for future funding as the plugin develops, evolves and changes over time. Additional funding would be needed to support its development as we slowly transition into a sustainable business model that will keep the project self-sustained.
[FEASIBILITY] Are you or any member of your team working on any other proposals in this Fund9?
Yes[FEASIBILITY] Are you or your team working on any other proposals from previous Funds?
No[AUDITABILITY] Please describe what you will measure to track your project's progress, and how will you measure these?
The delivery of the documentation and its usage will be key indicators that we've successfully delivered useful documentation for the community to use.
A complete set of documentation around the core plugin:
https://cardanopress.io/docs-category/cardanopress-core/
Along with more active users asking questions in the corresponding forum category:
https://cardanopress.io/community/cardanopress-core/
Traffic stats via Google Analytics showing an increase in page views from the time of the proposal to the post-competition date will indicate usage.
[AUDITABILITY] What does success for this project look like?
More projects installing CardanoPress and using it as their base of development will be a key measure of success for the project.
Making it easier for projects to install, configure and customise their instance will show how easy it is to build a functioning DApp on Cardano with WordPress and CardanoPress.
Seeing other web agencies and developers build services around the plugin is another key measurement of success. Seeing others build thriving businesses around our plugins would be an amazing indicator of success.
[AUDITABILITY] Please provide information on whether this proposal is a continuation of a previously funded project in Catalyst or an entirely new one.
This is not a continuation of a previously funded proposal.
Team
This proposal is by the team that has created CardanoPress https://cardanopress.io
The team have been writing and creating helpful tutorials for the Cardano community for the last year with the Learn Cardano channel and main website https://cardanode.com.au.
