Updated docs
This commit is contained in:
Prozilla
parent
c98407ee0b
commit
716f638908
7 changed files with 57 additions and 10 deletions
|
|
@ -5,6 +5,7 @@
|
|||
## Table of Contents
|
||||
|
||||
- [Features](features/README.md)
|
||||
- [Design](design/README.md)
|
||||
- [Roadmap](roadmap/README.md)
|
||||
- [Configurations](configurations/README.md)
|
||||
- [Contributing](contributing/README.md)
|
||||
|
|
@ -41,11 +42,11 @@ Once the initial setup is complete, you can simply run `npm run deploy` and your
|
|||
|
||||
- [src](../src) directory
|
||||
|
||||
Contains all code for the application, including CSS, JS and HTML files.
|
||||
Contains all code for the application, including CSS, JS and HTML files. This directory makes use of a feature-based folder structure.
|
||||
|
||||
- [public](../public) directory
|
||||
|
||||
Contains all static files like images, webfonts and vector graphics as well as the [index.html](../public/index.html) file, which contains all metadata and contains all bundled scripts after the build step.
|
||||
Contains all static files like images, webfonts and vector graphics as well as the [index.html](../public/index.html) file, which contains all metadata and contains all bundled scripts after the build step. Also includes the [config](../public/config) and [documents](../public/documents) folders from where certain files are loaded into the [virtual drive](features/virtual-drive/README.md).
|
||||
|
||||
- [docs](.) directory
|
||||
|
||||
|
|
|
|||
17
docs/design/README.md
Normal file
17
docs/design/README.md
Normal file
|
|
@ -0,0 +1,17 @@
|
|||
[← Back](../README.md)
|
||||
|
||||
# Design
|
||||
|
||||
ProzillaOS is designed in Figma by Prozilla. You can view the design file [here](https://www.figma.com/file/bEE5RyWgV0QILcXpZWEk2r/ProzillaOS?type=design&node-id=0%3A1&mode=design&t=7KR1tKCp9H5cK3hf-1).
|
||||
|
||||
### Preview
|
||||
|
||||
<img src="../../public/media/screenshots/Screenshot1.png"/>
|
||||
|
||||
## UI Icons
|
||||
|
||||
ProzillaOS uses [FontAwesome](https://fontawesome.com/) icons in its UI.
|
||||
|
||||
## App Icons
|
||||
|
||||
The apps use icons that are mostly modified versions of FontAwesome icons, designed by Prozilla.
|
||||
7
docs/features/storage/README.md
Normal file
7
docs/features/storage/README.md
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
[← Back](../README.md)
|
||||
|
||||
# Storage
|
||||
|
||||
ProzillaOS makes use of the local storage to store persistent data. The data is loaded by the virtual root during the initialization process. On the first run, the default data is loaded.
|
||||
|
||||
The data is converted from class instances to a JSON object and then to a string by the virtual root before it is stored in the local storage. To load data from the local storage, an inverse process is used.
|
||||
|
|
@ -4,10 +4,9 @@
|
|||
|
||||
The virtual drive is a virtual file and directory system. The root directory is a virtual folder and the access point for all interactions with the virtual drive.
|
||||
|
||||
The initial files added to every instance of ProzillaOS, can be found and configured in [hooks/virtual-drive/VirtualRootContext.js](../../../src/hooks/virtual-drive/VirtualRootContext.js)
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [Virtual Root](./virtual-root/README.md)
|
||||
- [Virtual File](./virtual-file/README.md)
|
||||
- [Virtual Folder](./virtual-folder/README.md)
|
||||
|
||||
|
|
|
|||
|
|
@ -2,8 +2,4 @@
|
|||
|
||||
# Virtual Folder
|
||||
|
||||
Virtual folders can contain files and sub-folders.
|
||||
|
||||
## Virtual Root
|
||||
|
||||
The virtual root is a virtual folder that contains all other folders and files. It serves as the root directory for the virtual drive and is used as an access point in applications.
|
||||
Virtual folders can contain files and sub-folders.
|
||||
9
docs/features/virtual-drive/virtual-root/README.md
Normal file
9
docs/features/virtual-drive/virtual-root/README.md
Normal file
|
|
@ -0,0 +1,9 @@
|
|||
[← Back](../README.md)
|
||||
|
||||
# Virtual Root
|
||||
|
||||
The virtual root is a virtual folder that contains all other folders and files. It serves as the root directory for the virtual drive and is used as an access point in applications.
|
||||
|
||||
The default data for the virtual root is set in the `loadDefaultData()` function in the `VirtualRoot` class.
|
||||
|
||||
For more information about how the virtual root is stored and loaded, check the [Storage](../../storage/README.md) docs.
|
||||
|
|
@ -2,12 +2,14 @@
|
|||
|
||||
# Roadmap
|
||||
|
||||
This is a list of planned features.
|
||||
This is a list of planned/in progress features.
|
||||
|
||||
## Taskbar
|
||||
|
||||
The taskbar is a collection of utilities and pinned applications displayed on top of the desktop. Its utilities include a search field, (battery percentage), (internet connection status), volume control, date and time and a button for viewing the desktop.
|
||||
|
||||
See [Taskbar docs](../features/taskbar/README.md) for the current documentation of this feature.
|
||||
|
||||
## Desktop
|
||||
|
||||
A customizable desktop with a wallpaper and shortcuts to applications, files or folders.
|
||||
|
|
@ -15,3 +17,19 @@ A customizable desktop with a wallpaper and shortcuts to applications, files or
|
|||
## Storage
|
||||
|
||||
A library for saving and loading persistent data using local storage.
|
||||
|
||||
See [Storage docs](../features/storage/README.md) for the current documentation of this feature.
|
||||
|
||||
## Settings app
|
||||
|
||||
A settings app that allows you to configure and personalize your version of ProzillaOS.
|
||||
|
||||
See [Settings docs](../features/applications/settings/README.md) for the current documentation of this feature.
|
||||
|
||||
## Visual Studio Code clone
|
||||
|
||||
A fully functional VSC clone called Code Editor.
|
||||
|
||||
## Modals
|
||||
|
||||
Modular windows, including alerts, confirmation dialogs and a file selector.
|
||||
|
|
|
|||
Loading…
Reference in a new issue