Last updated 2 years ago
@chain-lib Documentation Website
Problem
Current chain-lib documentation is on github. This will be for creating a docusaurus website at the chain-lib.com website that we own.
Solution
Create a proper documentation website to make it easy for developers to use the API, and to ease the creation of plugins.
Total to date
This is the total amount allocated to @chain-lib Documentation Website.
About this idea
What is chain-lib/cardano-api & chain-lib/cardano-components?
Chain lib is an open-source blockchain library monorepo. That means that multiple related projects will all be worked on in this repository.
Cardano-api is a wallet API that follows CIP-30 dapp connector. An easy analogy is that it is building the truffle sweet, for Cardano. It is difficult for a developer that is not intimately failure with Cardano and message signing to use CIP-30. Therefore this API also exposes several functions to staking and transactions easier.
Cardano-components are web-components (ie you can use them in any framework, react, vue, angular, etc), that utilize the Cardano blockchain. Currently, there are components for initializing cardano-api, asking the user for permission to connect to your wallet, sending transactions, and staking. You can find more proposed components in the dapp funding section. Every new component is used to update, add to, and test cardano-api.
Overview
When this project is finalized a docusaurus website for chain-lib/cardano-api and chain-lib/cardano-components will be created. This will make it easier for developers to utilize these Cardano-based open source libraries which will directly impact the number of developers using those open source projects. It will also make it easier for developers to create plugins for this framework impacting the amount of use and utility those open source projects can have.
In order to make sure the website is always up to date, the website will be generated (as much as possible) to make sure there is always up-to-date information.
Definition of Success
Within the first 3 months, the website should be fully updated and operational, likely sooner. This is a high-priority project. Long term success will be tracked by how easy it is for a developer to pick up either cardano-api or cardano-components and integrate it within their own projects.
Budget Breakdown
Development = $50 USD * ~64 hrs
Writting Proper documentation = $50 USD * ~10 hrs
Website URL = $60 USD yearly
Taxes = $942.20 USD
Monthly report
NB: Monthly reporting was deprecated from January 2024 and replaced fully by the Milestones Program framework. Learn more here
Progress report
Progress report
Progress report
Team
Novella / Cardano Keys Developer, SPO, Alanzo Purple tester, Plutus Pioneer 1, and already built several components inside the github repo.
