Skip to content

Commit

Permalink
docs: Add section overview
Browse files Browse the repository at this point in the history
  • Loading branch information
oliversalzburg committed Jan 2, 2023
1 parent c69a8e7 commit db17fad
Show file tree
Hide file tree
Showing 3 changed files with 75 additions and 2 deletions.
8 changes: 7 additions & 1 deletion packages/documentation/docs/index.md
Original file line number Diff line number Diff line change
@@ -1 +1,7 @@
# Kitten Science
# Kitten Scientists v2

!!! warning

Documenting all features has only been started since the beta phase. This documentation is part of the ongoing development effort and it is incomplete.

Please refer to the [Sections](sections/overview) for the current documentation.
68 changes: 67 additions & 1 deletion packages/documentation/docs/sections/overview.md
Original file line number Diff line number Diff line change
@@ -1 +1,67 @@
# Science
# Overview

## Introduction

The UI of KS is divided into several major sections. The names of these sections correlate to the main tabs in the KG UI.

Refer to the individual section documentation pages for details of the automation features on those sections.

## UI Concepts

### Panels

The UI of KS is made up of _panels_. You recognize a panel from the little `+` symbol on it. When you click on the `+`, the panel expands and the `+` turns into a `-`. When you now click the `-`, the panel collapses again.

!!! note

The `+`/`-` button is often referred to as an _expando_.

Most panels are also [settings](#settings). Which means that they have a **checkbox** as their top element, which is always visible, even when the panel is collapsed. When you _disable_ this setting, it causes any automation that is controlled through that section of the UI to be bypassed.

#### Utilities

!!! warning

These buttons are likely to be replaced by a different approach. Don't get used to them.

Some panels, when expanded, show 3 more buttons:

1. Reset to defaults

Set all options to the values that come with KS.

1. Enable all options

Activates everything.

1. Disable all options

Turns everything off.

### Settings

A _setting_ in KS is most commonly a checkbox. When the checkbox is checked, this feature is active. If the checkbox is unchecked, the feature is inactive.

Some settings also come with additional options. These are shown on the same line as the checkbox. You can click on these options to change their value. Sometimes, these options behave like expando buttons and collapse an entire new panel with options.

### Triggers

One common option to see is the _trigger_, symbolized by a little lightning. A trigger usually communicated at which threshold an automation should become active. Which resource this threshold refers to, is documented with the individual automations.

Triggers can be absolute values or, most commonly, a percentage. This percentage then usually refers to your storage capacity for a given resource.
When you enter a percentage value into KS, it expects you to provide it as a value between `0` and `1`. So if you wanted a trigger value at ¾ of your storage capacity, you'd enter `0.75`.

### Limits

Another common option is the _limit_. This will usually prevent an automation from going over a certain value. The most important aspects to understand are:

- `-1` means _infinity_. Effectively disables the limit.
- `0` means don't do anything ever.
- any other number will be the limit for this automation.

!!! hint

When entering limits, you can usually use the KG notations for big numbers. So `9.5M` will become `9,500,000`. You _have to_ use upper-case letters for this to work though.

_[KG]: Kittens Game
_[KS]: Kitten Scientists \*[UI]: User interface
1 change: 1 addition & 0 deletions packages/documentation/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ extra:
- icon: fontawesome/brands/github
link: https://github.com/kitten-science/
markdown_extensions:
- abbr
- admonition
- pymdownx.details
- pymdownx.highlight:
Expand Down

0 comments on commit db17fad

Please sign in to comment.