diff --git a/docs/configurations/README.md b/docs/configurations/README.md index c4d5125..bb4e4cd 100644 --- a/docs/configurations/README.md +++ b/docs/configurations/README.md @@ -2,7 +2,7 @@ # Configurations -All configs can be found in the [src/config](../../src/config) directory. +All configs can be found in the [config](../../src/config) directory. ## Settings diff --git a/docs/features/README.md b/docs/features/README.md index efa0e3e..d49c90b 100644 --- a/docs/features/README.md +++ b/docs/features/README.md @@ -2,11 +2,12 @@ # Features -Most code for features can be found in the [src/features](../../src/features) directory. This directory is a library that is mostly used by files in the [src/components](../../src/components) and [src/hooks](../../src/hooks) directory. +Most code for features can be found in the [features](../../src/features) directory. This directory is a library that is mostly used by files in the [components](../../src/components) and [hooks](../../src/hooks) directory. ## Table of Contents - [Applications](./applications/README.md) - [Virtual Drive](./virtual-drive//README.md) - [Windows](./windows/README.md) +- [Taskbar](./taskbar/README.md) diff --git a/docs/features/applications/README.md b/docs/features/applications/README.md index 9bfe4c3..f8b70d9 100644 --- a/docs/features/applications/README.md +++ b/docs/features/applications/README.md @@ -9,6 +9,36 @@ Applications (sometimes shortened to apps) are processes that open a window when - [ Terminal](terminal/README.md) - [ File Explorer](file-explorer/README.md) - [ Media Viewer](media-viewer/README.md) +- [ Text Editor](text-editor/README.md) + +## Common components + +### Header menu + +The header menu is a useful component that can be added to app windows for quick access to useful functions, like saving and opening files. The header menu can also be used to add shortcuts for functions. + +## Template components + +### Webview + +The webview template can be used to turn a webpage into an application by simply setting a source property. For more information, see the [example](#turning-a-webpage-into-an-application) below. + +#### Example + +```js +// src/features/applications/applications.js + +import { WebView } from "../../components/applications/templates/WebView.jsx"; + +export default class ApplicationsManager { + static APPLICATIONS = [ + // ... + new Application("Web App", "web-app", WebView, { source: "https://prozilla.dev/" }), + ] + + // ... +} +``` ## Examples @@ -37,21 +67,4 @@ export default class ApplicationsManager { // ... } -``` - -### Turning a webpage into an application - -```js -// src/features/applications/applications.js - -import { WebView } from "../../components/applications/templates/WebView.jsx"; - -export default class ApplicationsManager { - static APPLICATIONS = [ - // ... - new Application("Web App", "web-app", WebView, { source: "https://prozilla.dev/" }), - ] - - // ... -} ``` \ No newline at end of file diff --git a/docs/features/applications/terminal/README.md b/docs/features/applications/terminal/README.md index 316eba8..bb9d731 100644 --- a/docs/features/applications/terminal/README.md +++ b/docs/features/applications/terminal/README.md @@ -6,7 +6,7 @@ A command line tool. ## Commands -See [src/features/applications/terminal/commands.js](../../../../src/features/applications/terminal/commands.js) for a list of commands. You can edit this file to add/remove/edit commands. +See [features/applications/terminal/commands.js](../../../../src/features/applications/terminal/commands.js) for a list of commands. You can edit this file to add/remove/edit commands. ### Examples diff --git a/docs/features/applications/text-editor/README.md b/docs/features/applications/text-editor/README.md new file mode 100644 index 0000000..0f6d5c5 --- /dev/null +++ b/docs/features/applications/text-editor/README.md @@ -0,0 +1,5 @@ +[← Back](../README.md) + +# Text Editor + +An application for editing text documents. \ No newline at end of file diff --git a/docs/features/taskbar/README.md b/docs/features/taskbar/README.md new file mode 100644 index 0000000..3b976bf --- /dev/null +++ b/docs/features/taskbar/README.md @@ -0,0 +1,13 @@ +[← Back](../README.md) + +# Taskbar + +The taskbar serves as a hub for access to various other functionalites, mainly applications. It's very similar to Window's taskbar. + +The taskbar can be split up into 3 main segments: + +- Menus - This includes the home menu, where you can find quick access and a list of applications and the search menu, where you can search for applications by name. + +- Apps list - This is a list of pinned applications, similar to how Window's taskbar pinning works. + +- Indicators - This is a group of indicators that are used to display information, like battery power, network connection and volume. \ No newline at end of file diff --git a/docs/features/virtual-drive/README.md b/docs/features/virtual-drive/README.md index 0159709..b658482 100644 --- a/docs/features/virtual-drive/README.md +++ b/docs/features/virtual-drive/README.md @@ -4,6 +4,8 @@ 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 File](./virtual-file/README.md)