Giter Site home page Giter Site logo

Docs website about bch-devsuite HOT 4 CLOSED

actorforth avatar actorforth commented on July 29, 2024 1
Docs website

from bch-devsuite.

Comments (4)

codewithcats avatar codewithcats commented on July 29, 2024 1

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.

SuperCipher avatar SuperCipher commented on July 29, 2024 1

The website is up can be seen here.
https://docs.actorforth.org/

from bch-devsuite.

codewithcats avatar codewithcats commented on July 29, 2024

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

photo_2021-12-16_13-39-19

from bch-devsuite.

merc1er avatar merc1er commented on July 29, 2024

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)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    šŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo 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.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ā¤ļø Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.