namillum
Version:
Bubble Protocol SDK
60 lines (37 loc) • 2.1 kB
Markdown
<!-- markdownlint-disable MD033 MD041 MD002 -->
[](https://travis-ci.com/Zilliqa/dev-docs)
<p align="center">
<img alt="dev-docs logo" src="https://i.ibb.co/gDtknr3/dev-docs-log.png" height="50px" />
<h1 align="center">Zilliqa Developer Documentation</h1>
</p>
Welcome to Zilliqa Developer Documentation!
This is a private repository hosting all the docs for developers inside Zilliqa.
Start reading from [index](index.md).
#### Table of Content
- [Scope](#scope)
- [Structure](#structure)
- [Viewing](#viewing)
- [Searching](#searching)
- [Contributing](#contributing)
- [Roadmap](#roadmap)
---
## Scope
This repository is essentially a knowledge base for all the developers inside Zilliqa. We encourage you to share any knowledge in any perspective about development.
> A gentle reminder: Don't forget to remove any sensitive information like password and keys before posting anything here.
## Structure
The docs are organized by topics and located in different categories. This keeps the repository clean and tidy. If you have better idea in organizing the docs, please [contribute](#contributing)!
## Viewing
You can read the docs on Github directly or use any markdown rendering engine locally. We suggest using [VSCode](https://github.com/Microsoft/vscode) as both viewing and editing tools for markdown docs.
## Searching
Github already did the indexing for you. Key in your keywords in the search bar and look for your interested topics.
## Contributing
Create an [issue](https://github.com/Zilliqa/dev-docs/issues) when you feel something can be improved.
To contribute with new information or make changes to existing documentation, please read the [Contributing Guideline](CONTRIBUTING.md).
## Roadmap
- [x] Code owners
- [x] Travis CI
- [x] Formatting and linting
- [x] Create contribution guide
- [ ] Pull request template
- [ ] Issue template
- [ ] Make use of the [front matter](https://jekyllrb.com/docs/front-matter/) to provide more metadata about the doc.