All Projects → cortezaproject → Corteza Docs

cortezaproject / Corteza Docs

Licence: apache-2.0
Documentation, manual, instructions

Labels

Projects that are alternatives of or similar to Corteza Docs

Sblg
static blog utility
Stars: ✭ 75 (-7.41%)
Mutual labels:  makefile
Android device zuk z2 plus
Android device configuration for ZUK Z2 (z2_plus)
Stars: ✭ 78 (-3.7%)
Mutual labels:  makefile
Freedom Tools
Tools for SiFive's Freedom Platform
Stars: ✭ 80 (-1.23%)
Mutual labels:  makefile
Hornbill Examples
Stars: ✭ 76 (-6.17%)
Mutual labels:  makefile
Kbd
for building keyboard libraries
Stars: ✭ 77 (-4.94%)
Mutual labels:  makefile
Do more with twitter data
Tutorials for getting the most out of Twitter data.
Stars: ✭ 78 (-3.7%)
Mutual labels:  makefile
Packages
Community maintained packages for OpenWrt.
Stars: ✭ 74 (-8.64%)
Mutual labels:  makefile
K8s Mediaserver Operator
Repository for k8s Mediaserver Operator project
Stars: ✭ 81 (+0%)
Mutual labels:  makefile
Handbook
The Niteo Handbook
Stars: ✭ 77 (-4.94%)
Mutual labels:  makefile
Docker Tinycore
Tiny Core Linux Docker image building scripts and Dockerfile
Stars: ✭ 79 (-2.47%)
Mutual labels:  makefile
Homeland Docker
🚀 Deployment Homeland with Docker
Stars: ✭ 76 (-6.17%)
Mutual labels:  makefile
Rusted Switch
Nintendo Switch Homebrew with Rust 🦀
Stars: ✭ 75 (-7.41%)
Mutual labels:  makefile
Pragmaticai
[Book-2019] Pragmatic AI: An Introduction to Cloud-based Machine Learning
Stars: ✭ 79 (-2.47%)
Mutual labels:  makefile
Adafruit atmega32u4 breakout board
Atmega32u4 Breakout Board
Stars: ✭ 75 (-7.41%)
Mutual labels:  makefile
Openwrt Kcptun
kcptun for OpenWrt
Stars: ✭ 80 (-1.23%)
Mutual labels:  makefile
Zcash Apple
Zcash for Apple platforms
Stars: ✭ 75 (-7.41%)
Mutual labels:  makefile
Stm32cube Gcc
A developement environment for projects based on the STM32Cube firmware.
Stars: ✭ 78 (-3.7%)
Mutual labels:  makefile
Learn machine learning
Road to Machine Learning
Stars: ✭ 81 (+0%)
Mutual labels:  makefile
Awesome Blogdown
An awesome curated list of blogs built using blogdown
Stars: ✭ 80 (-1.23%)
Mutual labels:  makefile
Cloudformation Templates
Common tasks automated by CloudFormation
Stars: ✭ 79 (-2.47%)
Mutual labels:  makefile

Corteza technical and user documentation

  • link:src/overview/index.adoc[Overview]
  • link:src/releases/index.adoc[Releases]
  • link:src/user/index.adoc[User manual]
  • link:src/extdev/index.adoc[Extending and customization]
  • link:src/maint/index.adoc[Maintainer's manual]
  • link:src/coredev/index.adoc[Core developer's documentation]
  • link:src/manage/index.adoc[System management]

== Authoring

Documentation is written in https://asciidoctor.org/docs/what-is-asciidoc/[AsciiDoc] format and processed with https://asciidoctor.org/[AsciiDoctor]

Before you start, be sure you are familiar with https://asciidoctor.org/docs/asciidoc-writers-guide/[syntax and formatting] rules of AsciiDoc format.

.https://asciidoctor.org/docs/asciidoc-recommended-practices/[Rules to follow]:

  • One sentence per line.
  • Atx-style section titles

and other recommended practices from the linked page

=== Structure

Documentation is divided into 6 major chapters:

  • overview
  • releases
  • user manual
  • extending
  • maintainer
  • core developer
  • system management

=== Building manually

Use provided Makefile with task for building individual major chapters as HTML.

.Build all chapters as HTML (and put them under dist/html/ folder) [source]

make html

.Build user manual chapter as HTML (and put it under dist/html/user folder) [source]

make html.user

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].