Documentation/BinStack
2
0
Fork 0
Code Issues Releases Activity

Update docs

Browse Source
This commit is contained in:
Skylar Ittner 2018-09-22 23:20:03 -06:00
parent 19ad587387
commit 6aacd559ed
7 changed files with 11 additions and 254 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/Locations and Categories.md
View File

@ -1,6 +1,6 @@
# Locations and Categories # Locations and Categories
<iframe width="560" height="315" sandbox="allow-same-origin allow-scripts" src="https://video.netsyms.com/videos/embed/58d7ea3a-f127-4481-931f-9d4f65aa281e" frameborder="0" allowfullscreen></iframe> <div class="aspect-16x9"><iframe width="560" height="315" sandbox="allow-same-origin allow-scripts" src="https://video.netsyms.com/videos/embed/58d7ea3a-f127-4481-931f-9d4f65aa281e" frameborder="0" allowfullscreen></iframe></div>
## Locations ## Locations

0
docs/API Documentation.md → docs/Self-Hosting and Development/API Documentation.md
View File

2
docs/System Requirements.md → docs/Self-Hosting and Development/System Requirements.md
View File

@ -14,8 +14,6 @@ The Business Apps are very lightweight on server resources. The minimum support
* Ubuntu * Ubuntu
* Debian * Debian
* PHP * PHP
* 7.0
* 7.1
* 7.2 * 7.2
* Database * Database
* MySQL 5.7+ * MySQL 5.7+

117
docs/images/docs-icon.svg
View File

@ -1,117 +0,0 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!-- Created with Inkscape (http://www.inkscape.org/) -->
<svg
xmlns:dc="http://purl.org/dc/elements/1.1/"
xmlns:cc="http://creativecommons.org/ns#"
xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
xmlns:svg="http://www.w3.org/2000/svg"
xmlns="http://www.w3.org/2000/svg"
xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
width="512"
height="512"
viewBox="0 0 511.99999 511.99999"
id="svg2"
version="1.1"
inkscape:version="0.91 r13725"
sodipodi:docname="docs-icon.svg"
inkscape:export-filename="/home/skylar/Documents/Assets/Graphics/docs-icon.png"
inkscape:export-xdpi="45"
inkscape:export-ydpi="45">
<defs
id="defs4" />
<sodipodi:namedview
id="base"
pagecolor="#ffffff"
bordercolor="#666666"
borderopacity="1.0"
inkscape:pageopacity="0.0"
inkscape:pageshadow="2"
inkscape:zoom="0.98994949"
inkscape:cx="52.220574"
inkscape:cy="225.3771"
inkscape:document-units="px"
inkscape:current-layer="layer1"
showgrid="false"
units="px"
inkscape:window-width="1920"
inkscape:window-height="1023"
inkscape:window-x="107"
inkscape:window-y="1024"
inkscape:window-maximized="1" />
<metadata
id="metadata7">
<rdf:RDF>
<cc:Work
rdf:about="">
<dc:format>image/svg+xml</dc:format>
<dc:type
rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
<dc:title />
</cc:Work>
</rdf:RDF>
</metadata>
<g
inkscape:label="Layer 1"
inkscape:groupmode="layer"
id="layer1"
transform="translate(0,-540.36219)">
<rect
y="593.73596"
x="56"
height="50"
width="400"
id="rect4187"
style="fill:#00b0ff;fill-opacity:1;stroke:none;stroke-width:5;stroke-miterlimit:4;stroke-dasharray:5, 5;stroke-dashoffset:0;stroke-opacity:1" />
<rect
style="fill:#9e9e9e;fill-opacity:1;stroke:none;stroke-width:5;stroke-miterlimit:4;stroke-dasharray:5, 5;stroke-dashoffset:0;stroke-opacity:1"
id="rect4150"
width="380"
height="50"
x="76"
y="683.25037" />
<rect
style="fill:#9e9e9e;fill-opacity:1;stroke:none;stroke-width:5;stroke-miterlimit:4;stroke-dasharray:5, 5;stroke-dashoffset:0;stroke-opacity:1"
id="rect4154"
width="380"
height="50"
x="76"
y="953.25037" />
<g
id="g4162"
style="fill:#bdbdbd">
<rect
style="fill:#bdbdbd;fill-opacity:1;stroke:none;stroke-width:5;stroke-miterlimit:4;stroke-dasharray:5, 5;stroke-dashoffset:0;stroke-opacity:1"
id="rect4148"
width="320"
height="50"
x="136"
y="773.25037" />
<circle
r="12.5"
cy="798.25037"
cx="101.19038"
id="path4160"
style="fill:#bdbdbd;fill-opacity:1;stroke:none;stroke-width:5;stroke-miterlimit:4;stroke-dasharray:5, 5;stroke-dashoffset:0;stroke-opacity:1" />
</g>
<g
transform="translate(40,90.000002)"
id="g4162-3"
style="fill:#bdbdbd">
<rect
style="fill:#bdbdbd;fill-opacity:1;stroke:none;stroke-width:5;stroke-miterlimit:4;stroke-dasharray:5, 5;stroke-dashoffset:0;stroke-opacity:1"
id="rect4148-6"
width="280"
height="50"
x="136"
y="773.25037" />
<circle
r="12.5"
cy="798.25037"
cx="101.19038"
id="path4160-7"
style="fill:#bdbdbd;fill-opacity:1;stroke:none;stroke-width:5;stroke-miterlimit:4;stroke-dasharray:5, 5;stroke-dashoffset:0;stroke-opacity:1" />
</g>
</g>
</svg>
Side by Side

Before

Width:  |  Height:  |  Size: 3.7 KiB

127
docs/images/logo.svg
View File

@ -1,127 +0,0 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!-- Created with Inkscape (http://www.inkscape.org/) -->
<svg
xmlns:dc="http://purl.org/dc/elements/1.1/"
xmlns:cc="http://creativecommons.org/ns#"
xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
xmlns:svg="http://www.w3.org/2000/svg"
xmlns="http://www.w3.org/2000/svg"
xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
width="512"
height="512"
viewBox="0 0 512.00001 512.00001"
id="svg2"
version="1.1"
inkscape:version="0.91 r13725"
sodipodi:docname="logo.svg"
inkscape:export-filename="/home/skylar/Documents/Projects/Assets/SimpleInventory/logo_64.png"
inkscape:export-xdpi="11.25"
inkscape:export-ydpi="11.25">
<defs
id="defs4" />
<sodipodi:namedview
id="base"
pagecolor="#ffffff"
bordercolor="#666666"
borderopacity="1.0"
inkscape:pageopacity="0.0"
inkscape:pageshadow="2"
inkscape:zoom="0.49497475"
inkscape:cx="-135.9681"
inkscape:cy="352.66131"
inkscape:document-units="px"
inkscape:current-layer="layer1"
showgrid="false"
units="px" />
<metadata
id="metadata7">
<rdf:RDF>
<cc:Work
rdf:about="">
<dc:format>image/svg+xml</dc:format>
<dc:type
rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
<dc:title></dc:title>
</cc:Work>
</rdf:RDF>
</metadata>
<g
inkscape:label="Layer 1"
inkscape:groupmode="layer"
id="layer1"
transform="translate(0,-540.36216)">
<rect
style="opacity:1;fill:#ffffff;fill-opacity:1;stroke:none;stroke-width:20;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:0.74509804"
id="rect4726"
width="512"
height="512"
x="0"
y="540.36218"
rx="50"
ry="50" />
<g
id="g4241"
transform="translate(0,22.223356)">
<rect
ry="20"
rx="20"
y="837.27594"
x="92.609116"
height="100"
width="100"
id="rect4163"
style="opacity:1;fill:#4caf50;fill-opacity:1;stroke:none;stroke-width:50;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:0.74509804" />
<rect
ry="20"
rx="20"
y="837.27594"
x="206"
height="100"
width="100"
id="rect4163-3"
style="opacity:1;fill:#4caf50;fill-opacity:1;stroke:none;stroke-width:50;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:0.74509804" />
<rect
ry="20"
rx="20"
y="837.27594"
x="319.3909"
height="100"
width="100"
id="rect4163-3-7"
style="opacity:1;fill:#4caf50;fill-opacity:1;stroke:none;stroke-width:50;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:0.74509804" />
</g>
<g
id="g4237"
transform="translate(0,19.543226)">
<rect
ry="20"
rx="20"
y="727.60065"
x="149.30457"
height="100"
width="100"
id="rect4163-5"
style="opacity:1;fill:#4caf50;fill-opacity:1;stroke:none;stroke-width:50;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:0.74509804" />
<rect
ry="20"
rx="20"
y="727.60065"
x="262.69543"
height="100"
width="100"
id="rect4163-3-3"
style="opacity:1;fill:#00e676;fill-opacity:1;stroke:none;stroke-width:50;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:0.74509804" />
</g>
<rect
style="opacity:1;fill:#4caf50;fill-opacity:1;stroke:none;stroke-width:50;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:0.74509804"
id="rect4163-5-5"
width="100"
height="100"
x="206"
y="634.78845"
rx="20"
ry="20" />
</g>
</svg>
Side by Side

Before

Width:  |  Height:  |  Size: 3.8 KiB

4
docs/index.md
View File

@ -1,8 +1,6 @@
# BinStack
BinStack is the easy way to keep track of your business assets. Never wander in search of the stapler again. BinStack is the easy way to keep track of your business assets. Never wander in search of the stapler again.
## Features # Features
* __Asset Tracking__ * __Asset Tracking__
* Easily manage locations, tag numbers, assigned users, and other important item properties. * Easily manage locations, tag numbers, assigned users, and other important item properties.

13
mkdocs.yml
View File

@ -1,16 +1,21 @@
site_name: BinStack Docs site_name: BinStack Docs
theme: theme:
name: 'material' name: 'material'
logo: 'images/logo.svg' logo: 'https://static.netsyms.net/images/products/binstack/logo.svg'
favicon: 'images/docs-icon.svg' favicon: 'https://static.netsyms.net/images/netsyms/documentation/docs-icon.svg'
font: false
feature: feature:
tabs: false tabs: false
palette: palette:
primary: 'green' primary: 'green'
accent: 'green' accent: 'green'
extra_javascript: extra_javascript:
- track.js - 'https://static.netsyms.net/fontawesome/5.3.1/js/all.min.js'
- 'https://docs.netsyms.com/track.js'
extra_css:
- 'https://docs.netsyms.com/font.css'
- 'https://docs.netsyms.com/media.css'
site_author: Netsyms Technologies site_author: Netsyms Technologies
repo_name: 'Business/BinStack' repo_name: 'Business/BinStack'
repo_url: 'https://source.netsyms.com/Business/BinStack' repo_url: 'https://source.netsyms.com/Business/BinStack'
copyright: Copyright &copy; 2018 Netsyms Technologies. All rights reserved. Copying is allowed for instructional purposes (such as creating an internal user help document) as long as credit is given and this copyright notice is included. For other purposes, or if you are selling a product containing copied material, please <a href="https://netsyms.com/contact" target="_BLANK">contact us</a> for permission. copyright: <br /><a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://docs.netsyms.com/cc-by-sa88x31.png" /></a><br />Copyright &copy; 2018 Netsyms Technologies. Some rights reserved.<br />This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/">Creative Commons Attribution-ShareAlike 4.0 International License</a>.