First commit

Add documents
This commit is contained in:
Gauthier Provost 2017-10-10 16:03:56 +00:00
parent 5cc66ec648
commit d25076346d
28 changed files with 251912 additions and 0 deletions

View file

@ -1 +1,5 @@
# Kobol Offical Wiki
Powered by mkdocs : http://www.mkdocs.org/
Template : http://squidfunk.github.io/mkdocs-material/

3
docs/about.md Normal file
View file

@ -0,0 +1,3 @@
# About Kobol Team
We are a group of passionate people based in Singapore who love to build and design our own smart home solutions. Our background ranges from aerospace industry to data science, gathering a wide spectrum of engineering skills and experiences. We strongly believe in open source and always held the vision to create an open platform to let people express their creativity and hack around. Helios4 project is our way to contribute back to the OSS community.

1
docs/dev.md Normal file
View file

@ -0,0 +1 @@
### Work in progress

43
docs/docs.md Normal file
View file

@ -0,0 +1,43 @@
# Helios4 Documents
## Carrier Board
Doc-Type | Filename | Version | Date | Download | Description
---------|----------|---------|------|----------|------------
Schematics|Helios4 Simplified Schematics|rev 1.1|2017-08-09|[Download](/files/carrier/Helios4_Schematics_R1-1.pdf)|Helios4 Simplified Schematics - PDF
Mechanical|Helios4 Mechanical Assembly|rev 01|2017-08-05|[Download](/files/carrier/Helios4_Mechnical_Assembly.pdf)|Helios4 Carrier Mechanical Assembly
## A38x MicroSoM
Doc-Type | Filename | Version | Date | Download | Description
---------|----------|---------|------|----------|------------
Broshures|a38x Broschure|rev 1.0|2017-09-05|[Download](/files/som/brochure_a38x_microsom_2017-09-05.pdf)|Official SR a38x Broschure
Schematics|A38X Simplified Schematics|rev 2.0|2015-10-28|[Download](/files/som/a38x-microsom-schematics-simplified-rev2.00.pdf)|MicroSom A38X Simplified Schematics - PDF
Marvell Documents|Marvell ARMADA 38x Functional Specifications|rev xx|2015-10-25|[Link](https://marvellcorp.wufoo.com/forms/marvell-armada-38x-functional-specifications/)|Marvell ARMADA 38x Functional Specifications
Marvell Documents|Marvell ARMADA 38x Hardware Specifications|rev xx|2017-03-09|[Link](https://marvellcorp.wufoo.com/forms/marvell-armada-38x-hardware-specifications/)|Marvell ARMADA 38x Hardware Specifications
For more documents on the **A38x SoM** go to [SolidRun Wiki](https://wiki.solid-run.com/doku.php?id=products:a38x:documents)
## Casing
Doc-Type | Filename | Version | Date | Download | Description
---------|----------|---------|------|----------|-------------
Mechanical|Helios4 Case B|rev 4G|2017-09-01|[Download](/files/casing/Helios4_CaseB_r4g.skp)|Helios4 Case Mechanical Design - SketchUp
Mechanical|Helios4 Case B|rev 4G|2017-09-01|[Download](/files/casing/Helios4_CaseB_r4g.pdf)|Helios4 Case Mechanical Design - PDF
Mechanical|Helios4 Case B|rev 4G|2017-09-01|[Download](/files/casing/Helios4_CaseB_r4g.dxf)|Helios4 Case Mechanical Design - DXF
Mechanical|Helios4 Case B|rev 4G|2017-09-01|[Download](/files/casing/Helios4_CaseB_r4g.eps)|Helios4 Case Mechanical Design - EPS
Mechanical|Helios4 Case B Assembled|rev 4G|2017-09-01|[Download](/files/casing/Helios4_CaseB_r4g-assembled.skp)|Helios4 Case Mechanical Design Assembled - SketchUp
## Power Supply
Doc-Type | Filename | Version | Date | Download | Description
---------|----------|---------|------|----------|-------------
Certificate|YCZX AC/DC FCC VoC|rev xx|2016-03-22|[Download](/files/power-supply/YCZX_ACDC_FCC_VoC.jpg)|AC/DC Power Adapter FCC Verification of Conformity
Certificate|YCZX AC/DC CE CoC|rev xx|2016-03-22|[Download](/files/power-supply/YCZX_ACDC_CE_CoC.jpg)|AC/DC Power Adapter CE Certificate of Compliance
## Fan
Doc-Type | Filename | Version | Date | Download | Description
---------|----------|---------|------|----------|-------------
Datasheet|7015.pdf|rev xx|01-01-2016|[Download](/files/fan/Whee_fan_7015.pdf)|Casing FAN specs

1
docs/download.md Normal file
View file

@ -0,0 +1 @@
### Coming Soon

Binary file not shown.

Binary file not shown.

Binary file not shown.

File diff suppressed because it is too large Load diff

File diff suppressed because it is too large Load diff

File diff suppressed because it is too large Load diff

Binary file not shown.

Binary file not shown.

Binary file not shown.

After

Width:  |  Height:  |  Size: 698 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 688 KiB

Binary file not shown.

1
docs/hardware.md Normal file
View file

@ -0,0 +1 @@
### Work in progress

BIN
docs/img/favicon.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.8 KiB

BIN
docs/img/helios4_logo.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 6.1 KiB

1
docs/index.md Normal file
View file

@ -0,0 +1 @@
### Work in progress

1
docs/install.md Normal file
View file

@ -0,0 +1 @@
### Work in progress

3
docs/kernel.md Normal file
View file

@ -0,0 +1,3 @@
### Work in progress
[link](https://github.com/helios-4/linux-marvell)

3
docs/linux.md Normal file
View file

@ -0,0 +1,3 @@
### Work in progress
[link](https://github.com/helios-4/build)

1
docs/omv.md Normal file
View file

@ -0,0 +1 @@
### Work in progress

3
docs/uboot.md Normal file
View file

@ -0,0 +1,3 @@
### Work in progress
[link](https://github.com/helios-4/u-boot-marvell)

62
mkdocs.yml Normal file
View file

@ -0,0 +1,62 @@
# Project information
site_name: 'Helios4 Wiki'
site_description: 'Helios4 Wiki'
site_author: 'Kobol Team'
site_url: 'https://wiki.kobol.io'
site_favicon: 'img/favicon.png'
# Repository
repo_name: 'Helios4 GitHub Repo'
repo_url: 'https://github.com/helios-4'
# Copyright
copyright: 'Copyright © Kobol Team 2017'
# Documentation and theme
theme: 'material'
theme_dir: 'theme'
# Options
extra:
logo: './img/helios4_logo.png'
palette:
primary: 'teal'
accent: 'pink'
font:
text: 'Roboto'
code: 'Roboto Mono'
social:
- type: 'home'
link: 'https://kobol.io/helios4'
- type: 'github'
link: 'https://github.com/helios-4'
- type: 'facebook'
link: 'https://facebook.com/kobol.io'
- type: 'rss-square'
link: 'https://blog.kobol.io'
# Google Analytics
#google_analytics:
# - 'UA-XXXXXXXX-X'
# - 'auto'
# Extensions
markdown_extensions:
- admonition
- codehilite(guess_lang=false)
- toc(permalink=true)
pages:
- Introduction: 'index.md'
- Hardware: 'hardware.md'
- Software:
- U-Boot : 'uboot.md'
- Kernel : 'kernel.md'
- Linux : 'linux.md'
- OpenMediaVault : 'omv.md'
- Download: 'download.md'
- Install: 'install.md'
- Development: 'dev.md'
- Documents: 'docs.md'
- About: 'about.md'

View file

@ -0,0 +1,62 @@
<header class="md-header" data-md-component="header">
<nav class="md-header-nav md-grid">
<div class="md-flex">
<div class="md-flex__cell md-flex__cell--shrink">
<a href="{{ config.site_url | default(nav.homepage.url, true) }}" title="{{ config.site_name }}" class="md-header-nav__button md-logo">
{% if config.extra.logo %}
{% if config.extra.logo.icon %}
<i class="md-icon">{{ config.extra.logo.icon }}</i>
{% else %}
<img src="{{ base_url }}/{{ config.extra.logo }}" width="24" height="24">
{% endif %}
{% else %}
<i class="md-icon md-icon--home"></i>
{% endif %}
</a>
</div>
<div class="md-flex__cell md-flex__cell--shrink">
<label class="md-icon md-icon--menu md-header-nav__button" for="drawer"></label>
</div>
<div class="md-flex__cell md-flex__cell--stretch">
<span class="md-flex__ellipsis md-header-nav__title">
{% block site_name %}
{% if page %}
{% for parent in page.ancestors %}
<span class="md-header-nav__parent">
{{ parent.title }}
</span>
{% endfor %}
{% endif %}
{{ page.title | default(config.site_name, true) }}
{% endblock %}
</span>
</div>
<div class="md-flex__cell md-flex__cell--shrink">
<div class="md-header-nav__source">
<a href="/download" title="Go to Download" class="md-source">
<i class="md-icon" style="font-size: 1.8em; text-align: center;">sd_storage</i>
<div class="md-source__repository">
Download IMG
<ul class="md-source__facts">
<li class="md-source__fact">Coming Soon</li>
</ul>
</div>
</a>
</div>
</div>
{% if config.repo_url %}
<div class="md-flex__cell md-flex__cell--shrink">
<div class="md-header-nav__source">
{% include "partials/source.html" %}
</div>
</div>
{% endif %}
<div class="md-flex__cell md-flex__cell--shrink">
{% block search_box %}
<label class="md-icon md-icon--search md-header-nav__button" for="search"></label>
{% include "partials/search.html" %}
{% endblock %}
</div>
</div>
</nav>
</header>