https://github.com/block-core/documentation
Documentation for Blockcore, including how to contribute as a developer, naming conventions, guidelines and more.
https://github.com/block-core/documentation
blockchain blockcore documentation
Last synced: over 1 year ago
JSON representation
Documentation for Blockcore, including how to contribute as a developer, naming conventions, guidelines and more.
- Host: GitHub
- URL: https://github.com/block-core/documentation
- Owner: block-core
- License: mit
- Created: 2019-10-03T15:43:52.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-04T23:17:07.000Z (over 3 years ago)
- Last Synced: 2024-10-29T10:08:23.645Z (over 1 year ago)
- Topics: blockchain, blockcore, documentation
- Language: Batchfile
- Homepage: https://docs.blockcore.net
- Size: 21 MB
- Stars: 11
- Watchers: 12
- Forks: 12
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: docs/securityissues.md
Awesome Lists containing this project
README
About Blockcore Documentation
Blockcore Platform Documentation for Users and Developers
# Blockcore Documentation
Collection of documents used as user guide, architecture and technical reference for implementation of Blockcore technologies.
These documents are free (see [LICENSE](LICENSE)) and anyone can contribute, please feel free to do a PR with suggestions, additions, fixes, etc.
Don't expect all ideas and features written in these documents to be implemented. They are guidance documents, they should
document what already exists, what is being worked on, what is planned and ideas for the future.
If you discover a bug or other problem with Blockcore or supporting technologies, please report it. The are two different processes,
[responsible disclosure](security-issues.md) for security bugs and public issue tracking ([Blockcore](https://github.com/block-core/blockcore/issues)) for all other bugs.
### Build the Documentation Locally
If you're on Windows, you can simply run `doc.bat`. If you have not installed Python3, you will get a notification on how to install. You can simply do `python3` in the command promt, which will launc the Windows Store and you can install Python3.
Manually building and locally hosting the documentation:
```sh
python3 -m pip install --upgrade pip
python3 -m pip install mkdocs
python3 -m pip install mkdocs-material
python3 -m pip install mkdocs-git-revision-date-plugin
python3 -m pip install mkdocs-exclude-search
python3 -m mkdocs serve
```
## Contents
* [Contributing](contributing.md)
* [Coding Style](coding-style.md)
* [Security Issues](security-issues.md)
* [Signing Commits](signing-commits.md)
* [Architecture](architecture/)
## Contributing
Pull requests are welcome and appreciated. To contribute to Blockcore Documentation, first check the [contributing guidelines](docs/contribute.md).
# Attributions
The main front page is based upon source code from [MkDocs Material](https://github.com/squidfunk/mkdocs-material) and the same theme is used for the general layout.
Starting point for the documentation is based upon work by [MithrilMan](https://github.com/mithrilman/mithrilshards/).