Comments (4)
Here is what I & @merc1er think we should have in our docs site:
Getting Started
- quick way to get start with our tool step by step
- overall concept (not so detailed) about how things work together (with few diagrams)
- (optional) video tutorial
Advance Usage
- how to operate in advance use cases, use case by use case
API (or command) reference
- explanation of all available options/configurations that can be used
Architecture
- deeper details of how things work together
Sponsorship
- provide a way to funding us
less important sections
Contribution
- how to contribute to this project; how to do PR, for example
Project Roadmap
from bch-devsuite.
The website is up can be seen here.
https://docs.actorforth.org/
from bch-devsuite.
I rearranged sections in our README and merged to develop
branch (PR #33)
Documentation writing guideline
- The website will be generated from README.md. You write on the section you responsible for.
- Each h1 (start with #) will be split into different pages. for example, # Getting Started will be getting-started.html
- Each page will have it own menu on the sidebar
- Each h2 (start with ##) will be display as a submenu of its parent page
from bch-devsuite.
Iām thinking some info on the minimum and recommended specs to run mainnet would be useful in the docs š
from bch-devsuite.
Related Issues (20)
- Create a landing page for DevSuite
- Proper docker image tag management
- Update the README's structure
- Support SmartBCH mainnet
- Make setup script option to deploy both rest.bitcoin.com and bch-api at the same time
- SmartBCH support Testnet
- Support remote BCH RPC
- Potential security vulnerabilities in docs dependency HOT 1
- Expose smartbch p2p port to external network when running testnet or mainnet
- ./clean does not cleanup smartbchd directory
- Dump and restore smartbch
- Bitcoin Cash Node regtest Cli unable to update balance when transaction in mempool
- Upgrade smartBCH to v0.4.2
- Do not reindex BCHN each time
- Perform a full successful sync of smartbch(mainnet) and provide step-by-step instructions
- Urgent: Upgrade Bitcoincash node and Bitcoin Unlimited nodes
- smartBCH does not sync anymore
- Cant init without smartbch selected
- Upgrade bitcoin unlimited to 2.0.0.0
- Upgrade bitcoincash node to v26.0.0
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
š Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. ššš
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ā¤ļø Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from bch-devsuite.