Skip to content

Commit

Permalink
📝 Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
alicerunsonfedora committed Aug 4, 2021
1 parent 8b37a25 commit 4570c76
Show file tree
Hide file tree
Showing 8 changed files with 2,211 additions and 1,299 deletions.
14 changes: 14 additions & 0 deletions docs/00-release-notes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Release Notes

The following document contains information about the changes made, release per release, of Candella.

## v21.07 (Apple Cinnamon)
This is the first initial relase of Candella. The following information contains the changes rolled up from all beta releases.

- Adds search functionality to Celeste Desktop's app drawer, filtered by name or bundle ID.
- Fixes a tagging issue in version injection scripts.
- Adds new CHANGELOG file to builds.
- Updates design language of notification banners in NotificationKit.
- Updates ScreenKit to new Candella design language.
- Changes behavior of CAApplication.send_banner to include automatic and manual modes.
- Rebuilds Candella against the Ren'Py 7.4.4 SDK.
2 changes: 1 addition & 1 deletion docs/02-caberto-shell.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ There are two major components to Celeste Shell: the top bar and the launcher on

![Celeste Shell drawer](./images/celeste/drawer.png)

### Customizing the desktop {label:updated}
### Customizing the desktop

Click on the gear in the top bar to open the Settings pane for Celeste Shell. There are two sections in the settings: wallpaper selection, followed by the wallpaper display mode, which can be one of three options:

Expand Down
7 changes: 0 additions & 7 deletions docs/02-celeste-shell.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,6 @@

The default desktop shell for Candella is **Celeste** (formerly known as Caberto Shell). Celeste's interface is mainly inspired from the [Lomiri][lomiri] desktop environment and comes with per-user customizations.

!!! warning
Celeste is currently in a pre-release state and the documentation here may change as the project evolves.

![Default Celeste Shell desktop](./images/celeste/default.png)

## Using Celeste Shell
Expand All @@ -13,10 +10,6 @@ There are two major components to Celeste Shell: the top bar and the launcher on

![Celeste Shell drawer](./images/celeste/drawer.png)

### {label:new}

- As of 21.03-beta2, it is now possible to search for apps in the drawer by name or identifier.

### Customizing the desktop

Click on the gear in the top bar to open the Settings pane for Celeste Shell. There are two sections in the settings: wallpaper selection, followed by the wallpaper display mode, which can be one of three options:
Expand Down
4 changes: 2 additions & 2 deletions docs/03-candella-app.md
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ User interfaces for Candella apps utilize ScreenKit, an AliceOS framework that u

More information on generating user interfaces with ScreenKit [can be found in the AliceOS documentation][screenkit].

### Creating draggable windows {label:new}
### Creating draggable windows

It is recommended that, if possible, to give your app windows the ability to be dragged across the screen. This can be achieved by wrapping the window's content in a `drag` screen, supplying the following properties like in the example below:

Expand Down Expand Up @@ -179,7 +179,7 @@ Send an alert with respect to the user's settings.

- response (any): The response from the alert, if any. This response is also emitted as a signal.

### `CAApplication.send_banner(title, supporting, callback=Return('didClickRespond'))` {label:updated}
### `CAApplication.send_banner(title, supporting, callback=Return('didClickRespond'))`
Send a notification banner with respect to the user's settings.

The banner request can be used in one of two ways: automatic, which utilizes the CANotificationBanner class
Expand Down
2 changes: 1 addition & 1 deletion docs/11-notifications.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Banners in Candella have been moved to the right side of the screen and take up

![Banners in Candella](./images/design/banner.png)

## Creating modular banners {label:new}
## Creating modular banners

Notification banners can be generated automatically using the `CANotificationBanner` class, rather than at call time when invoking `CANotification.send_banner`. This class offers more control over the appearance of the banner and is typically easier to use than the manual mode in previous releases.

Expand Down
5 changes: 3 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
!!! warning "Prerelease Notice"
Candella is in a pre-release state and may change over time. This documentation tries to reflect the most current pre-release version of Candella.
!!! info "Documentation Notice"
The following documentation is written according to the latest release, **v21.07 (Apple Cinnamon)**. View the changelog
for information about previous releases and APIs.

## What makes Candella different?

Expand Down
6 changes: 3 additions & 3 deletions game/System/release_info.json
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
{
"distribution": {
"name": "Candella",
"version": "21.07",
"build_id": "2021076-182229",
"version": "21.08",
"build_id": "2021083-214813",
"channel": "beta",
"codename": "apple_cinnamon"
},
"build_date": "2021-07-06T18:22:29.398397"
"build_date": "2021-08-03T21:48:13.930916"
}
Loading

0 comments on commit 4570c76

Please sign in to comment.