Skip to content

maradeeym/cronos-docs

This branch is 1 commit ahead of, 28 commits behind crypto-org-chain/cronos-docs:gitbook.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

e838be3 · Aug 1, 2024
Jul 19, 2024
Oct 20, 2023
Jan 22, 2024
Jun 23, 2022
May 29, 2024
May 24, 2024
Jul 19, 2024
Aug 30, 2022
Aug 1, 2024
Jul 31, 2024
Jul 16, 2024
May 8, 2024
Apr 24, 2024
May 27, 2022
Jul 12, 2021
Nov 19, 2021
May 15, 2024
Jul 16, 2024
Jul 12, 2021
Jul 13, 2022
Jul 13, 2022

Repository files navigation

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/

Releases

No releases published

Packages

No packages published

Languages

  • Shell 100.0%