Giter Club home page Giter Club logo

cronos-docs's Introduction

README

Cronos Logo

Cronos Gitbook Documentation

The documentation in this repository site is meant to provide specifications and implementation details on Gitbook that will be useful developers or contributors to the main repository.

Getting Started

Contributing

  1. Fork this repository on Github
  2. Clone your forked repository with git clone https://github.com/YOURUSERNAME/cronos-docs.git
  3. cd cronos-docs
  4. git checkout gitbook to switch to the gitbook branch.
  5. git checkout -b [NewBranch] create a new branch and push your commits.
  6. Finally open a Pull Request.

Adding new page to the docs

  1. Create a markdown file [Newfile.md] under one of the main categories, e.g. for-users/, for-node-hosts/, for-dapp-developers/ or cronos-play/
  2. Open SUMMARY.md and add the new markdown file in the right file structure, e.g.
## FOR USERS

* [MetaMask](for-users/metamask.md)
* [Bridge](for-users/bridge/README.md)
  * [New file](for-users/bridge/Newfile.md)

Style guide

  • Use 3 levels at most
  • Categorise docs mostly per user, dapp, node hosts, Cronos play
  • Keep docs/sentences short, DRY and modular
  • Use tabs, tables, hints and relative page links
  • Double check SUMMARY.md and prefer the use of horizontal images

For more information on styling and syntax, refer to https://docs.gitbook.com/

cronos-docs's People

Contributors

lezzokafka avatar aw126 avatar zkaizhi avatar damoncro avatar rarcif avatar calvinaco avatar ken-cronos avatar cdc-william avatar kether-c avatar mofhusseini avatar ysong42 avatar crypto-matto avatar vincentysc avatar allthatjazzleo avatar francocro avatar dependabot[bot] avatar xinyucro avatar croyyds avatar julienrbrt avatar landanhu avatar 0x-kchau avatar tomtau avatar filipmartinsson avatar ivnnv avatar shih-yu avatar aasierra avatar leejw51crypto avatar

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.