Skip to content

Commit

Permalink
docs: new pages
Browse files Browse the repository at this point in the history
  • Loading branch information
Zakrok09 committed Aug 23, 2024
1 parent e50513e commit 0150588
Show file tree
Hide file tree
Showing 9 changed files with 72 additions and 36 deletions.
31 changes: 7 additions & 24 deletions .idea/codeStyles/Project.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 0 additions & 8 deletions .prettierrc

This file was deleted.

17 changes: 17 additions & 0 deletions .prettierrc.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Prettier configuration
arrowParens: avoid
requirePragma: false
insertPragma: false
proseWrap: always
trailingComma: "none"
tabWidth: 4
semi: true
useTabs: false
singleQuote: false
printWidth: 120
plugins:
- prettier-plugin-svelte
overrides:
- files: "*.svelte"
options:
parser: svelte
2 changes: 2 additions & 0 deletions Writerside/sdh.tree
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,9 @@
<toc-element topic="Stale-Data-Painter.md"/>
</toc-element>
<toc-element topic="Reference.md">
<toc-element topic="Conventions.md"/>
<toc-element topic="Envrionment-Variables.md"/>
<toc-element topic="Tauri-Event-Channels.md"/>
</toc-element>
<toc-element topic="Guides.md"/>
<toc-element topic="epilogue.md"/>
Expand Down
2 changes: 1 addition & 1 deletion Writerside/topics/Alerts.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Alerts

Start typing here...
Alerts (based on UI Toasts) are a safety feature for instant notification of an issue that occurred.
2 changes: 1 addition & 1 deletion Writerside/topics/Configuration-Interface.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Configuration Interface

Start typing here...
## Alert Listener
31 changes: 31 additions & 0 deletions Writerside/topics/Conventions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Conventions

Conventions set important rules for the development process that _should_ bring some kind of benefit. Commit, issue
or PR conventions where not present during DH08, but the one below are left for suggestion:

- use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/#summary) for commit naming

## Prettier formatting for TypeScript

The project uses the [Praxidike prettier configuration](https://github.com/TeamPraxidike/.github/blob/main/.prettierrc.yaml)
Of course, feel free to modify and completely change the Prettier configuration and make a better one.

```yaml
# Prettier configuration
arrowParens: avoid
requirePragma: false
insertPragma: false
proseWrap: always
trailingComma: "none"
tabWidth: 4
semi: true
useTabs: false
singleQuote: false
printWidth: 120
plugins:
- prettier-plugin-svelte
overrides:
- files: "*.svelte"
options:
parser: svelte
```
12 changes: 10 additions & 2 deletions Writerside/topics/Envrionment-Variables.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
# Envrionment Variables
# Environment Variables

Start typing here...
The Serpenta GUI makes use of several environment variables for its configuration. These define the behaviour of
the application allowing for easier non-business logic related configuration.

| Environment variable name | Values | Comment |
|--------------------------------|----------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `GUI_CUSTOM_APP_BAR` | `TRUE`/`FALSE` | Determines whether the top bar of the app is the custom one provided by Serpenta. Off will default the bar to use the native bar of the desktop environment. |
| `GUI_AGGREGATOR_COMMAND` | string | Determines the name of the function will be called by the Grand Data Distributor when aggregating the data which it will subsequently redistribute. |
| `GUI_COMMS_ALERT_CHANNEL_NAME` | string | |
| `GUI_COMMS_LOG_CHANNEL_NAME` | string | |
3 changes: 3 additions & 0 deletions Writerside/topics/Tauri-Event-Channels.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Tauri Event Channels

Start typing here...

0 comments on commit 0150588

Please sign in to comment.