Skip to content

Commit

Permalink
Updated doc structure
Browse files Browse the repository at this point in the history
  • Loading branch information
grodansparadis committed Jan 28, 2025
1 parent 946eb28 commit 2c3dd32
Show file tree
Hide file tree
Showing 5 changed files with 35 additions and 17 deletions.
Empty file added docs/.nojekyll
Empty file.
5 changes: 3 additions & 2 deletions docs/_coverpage.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@


![VSCP logo](./images/logo_400.png)
![VSCP logo](./images/logo_100.png)

# VSCP Works+

**VARNING**

This documentation is for the next version of VSCP Works+ (vscp-works-qt) and content change frequently.
This documentation is for the next version of VSCP Works+ (vscp-works-qt) and content (may) change frequently.

---

Expand All @@ -16,3 +16,4 @@ Scroll down to view docs.
[Docs](http://docs.vscp.org/)
[Downloads](https://www.vscp.org/#download)
[Get Started](./README)

20 changes: 18 additions & 2 deletions docs/_sidebar.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,30 @@
* [Windows](setting_up_the_system_on_windows.md)
* [Macintosh](setting_up_the_system_on_macintosh.md)
* [Raspberry Pi](setting_up_the_system_on_raspberry_pi.md)
* [Beaglebone](setting_up_the_system_on_beaglebone.md)
* [ArchLinuxArm](setting_up_the_system_on_an_embeded_archlinuxarm_system.md)

* Configure
* [Configuration file format](configuring_the_vscp_daemon.md)
* [Startup switches](startup_switches.md)
* [Files and directory structure](files_and_directory_structure.md)

* Connections
* [Introduction](connection.md)

* Session window
* [Introduction](session.md)

* Node scan window
* [Introduction](scan.md)

* Node configuration window
* [Introduction](configuration.md)

* Firmware update
* [Introduction](firmware_update.md)

* Module Description Files (MDF)
* [Introduction](mdf.md)

* Logging, diagnostic and debugging
* [Solving problems and troubleshooting](solving_problems.md)
* [logging](logging.md)
Expand Down
23 changes: 12 additions & 11 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,16 @@

<!-- docsify-themeable styles-->
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsify-themeable@0/dist/css/theme-simple.css" title="light">
<link rel="stylesheet alternative" href="https://cdn.jsdelivr.net/npm/docsify-themeable@0/dist/css/theme-simple-dark.css" title="dark">
<link rel="stylesheet alternative" href="https://cdn.jsdelivr.net/npm/docsify-themeable@0/dist/css/theme-simple-dark.css" title="dark">

<link rel="stylesheet" href="./theme-custom.css" type="text/css">

</head>
<body>
<div id="app"></div>
<script>
window.$docsify = {
name: 'the VSCP Works Toolbox',
name: 'the VSCP Works Tool',
repo: 'https://github.com/grodansparadis/vscp-works-qt',
coverpage: true,
loadSidebar: true,
Expand Down Expand Up @@ -94,21 +95,21 @@
}
</script>

<script src="https://unpkg.com/docsify/lib/docsify.min.js"></script>
<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
<script
src="https://cdn.jsdelivr.net/npm/docsify-darklight-theme@3/dist/docsify-themeable/main.min.js"
src="//cdn.jsdelivr.net/npm/docsify-darklight-theme@3/dist/docsify-themeable/main.min.js"
type="text/javascript">
</script>
<script
src="https://cdn.jsdelivr.net/npm/docsify-darklight-theme@3/dist/docsify-themeable/index.min.js"
src="//cdn.jsdelivr.net/npm/docsify-darklight-theme@3/dist/docsify-themeable/index.min.js"
type="text/javascript">
</script>

<script src="https://unpkg.com/docsify/lib/docsify.min.js"></script>
<script src="https://unpkg.com/prismjs/components/prism-bash.min.js"></script>
<script src="https://unpkg.com/prismjs/components/prism-cpp.min.js"></script>
<script src="https://unpkg.com/prismjs/components/prism-json.min.js"></script>
<script src="https://unpkg.com/docsify/lib/plugins/search.min.js"></script>
<script src="https://unpkg.com/docsify-variables/dist/docsify-variables.min.js"></script>
<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
<script src="//unpkg.com/prismjs/components/prism-bash.min.js"></script>
<script src="//unpkg.com/prismjs/components/prism-cpp.min.js"></script>
<script src="//unpkg.com/prismjs/components/prism-json.min.js"></script>
<script src="//unpkg.com/docsify/lib/plugins/search.min.js"></script>
<script src="//unpkg.com/docsify-variables/dist/docsify-variables.min.js"></script>
</body>
</html>
4 changes: 2 additions & 2 deletions docs/variables.xml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<var>
<creation-time>2024-03-26 14:43</creation-time>
<document-version>0.0.1-0 Alfa</document-version>
<creation-time>2025-01-28 20:24</creation-time>
<document-version>0.0.1</document-version>
</var>

0 comments on commit 2c3dd32

Please sign in to comment.