Rewrite documentation and complete shortcut and feature lists

This commit is contained in:
Samuel Onoja committed 2026-10-02 10:13:53 +01:00
1 parent bbb1eac189
commit 17243464f6
18 files changed
+257 -222

No files matched your search

+5 -7
View File
@@ -1,8 +1,7 @@
# Ferese website and handbook
The website introduces Ferese as one desktop you can make your own, with a handbook
built from the project’s Markdown guides so the website and repository share the same
documentation.
The website's handbook is built from the project's Markdown guides, so the website
and repository share the same documentation.
## Local preview
@@ -14,8 +13,7 @@ python3 -m http.server 8080 --bind 127.0.0.1 --directory build/site
```
Open http://localhost:8080 for the homepage or http://localhost:8080/docs/ for the
handbook, then rebuild and refresh the browser whenever you change the site sources or
guides.
handbook. Rebuild and refresh the browser after changing the site sources or guides.
- `site/index.html` and `site/styles.css`: homepage and shared visual design.
- `site/content/index.md`: handbook introduction.
@@ -28,8 +26,8 @@ guides.
## GitHub Pages
Choose **Settings → Pages → Source → GitHub Actions** to publish through the Pages
workflow, which runs when site or documentation changes reach `main` and can also be
started manually. The expected address is https://ferese-wm.github.io/ferese/.
workflow. It runs when site or documentation changes reach `main`; you can also
start it manually. The expected address is https://ferese-wm.github.io/ferese/.
The site uses relative links, including for handbook search, so it also works under the
`/ferese/` project path. Each build copies screenshots from `docs/images` into
+7 -9
View File
@@ -1,11 +1,10 @@
# Ferese handbook
Ferese is a window manager and desktop shell built together and configured in one place,
for people who want their desktop to be their own. This handbook helps you get settled,
shape the desktop around the way you work and understand what you can change.
Ferese combines a window manager and desktop shell with one configuration.
This handbook covers installation, settings and desktop controls.
[Browse screenshots](screenshots.md) to see the themes, layouts and desktop controls in
use
use.
## Get started
@@ -44,9 +43,8 @@ group windows, resize them and move between workspaces.
- [Screen sharing and recording](screen-sharing.md): share an app or display, or save a video.
- [Desktop portals](portals.md): integration with applications.
Personalize the desktop in Settings or edit `~/.config/ferese/config.kdl` directly, with
changes applying live and the last working configuration staying in place if an edit is
invalid.
Configure the desktop in Settings or edit `~/.config/ferese/config.kdl` directly.
Changes apply live. Invalid edits leave the last working configuration in place.
## Troubleshooting
@@ -54,6 +52,6 @@ If you need to end a session, `feresectl request-logout` asks for confirmation a
`feresectl exit` exits immediately, so save your work first. The [logs and recovery
guide](installation.md#logout-and-recovery) helps when something stops responding.
You can [report a problem](https://github.com/ferese-wm/ferese/issues) with the steps to
To [report a problem](https://github.com/ferese-wm/ferese/issues), include the steps to
reproduce it, relevant logs and whether you were using a nested preview or a direct
session, or start with [Development](development.md) if you’d like to contribute.
session. See [Development](development.md) to contribute.
+10 -12
View File
@@ -5,9 +5,9 @@
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="theme-color" content="#10151c" />
<meta name="description" content="Ferese is a Wayland desktop built around personalization." />
<meta name="description" content="Ferese is a configurable Wayland desktop." />
<meta property="og:title" content="Ferese — Wayland desktop" />
<meta property="og:description" content="A Wayland desktop built around personalization." />
<meta property="og:description" content="A configurable Wayland desktop." />
<meta property="og:type" content="website" />
<meta property="og:image" content="https://ferese-wm.github.io/ferese/assets/screenshots/ferese-main-hero.png" />
<meta name="twitter:card" content="summary_large_image" />
@@ -36,12 +36,11 @@
<main id="main" class="simple-home">
<section class="product-intro page-width">
<h1 class="product-tagline">
A Wayland desktop built around personalization.
A configurable Wayland desktop.
</h1>
<p class="product-description">
Ferese is a window manager and desktop shell
built together and configured in one place,
for people who want their desktop to be their own.
Ferese combines a window manager and desktop shell
with one configuration.
</p>
<div class="product-links">
<a class="button" href="docs/installation.html">Install Ferese</a>
@@ -64,7 +63,7 @@
</figure>
<section class="product-features page-width" aria-label="Features">
<article>
<h2>Flexible layouts</h2>
<h2>Window layouts</h2>
<p>
Scrolling columns, tree tiling, floating windows, and a workspace
overview. Use keyboard shortcuts or gestures to move around.
@@ -72,15 +71,14 @@
<a href="docs/configuration.html#layout">Configure layouts →</a>
</article>
<article>
<h2>A native desktop</h2>
<h2>Desktop tools</h2>
<p>
A menu bar, Control Center, Settings, notifications, and desktop
widgets, designed to work together.
A menu bar, Control Center, Settings, notifications, and desktop widgets.
</p>
<a href="docs/why-ferese.html">Explore Ferese →</a>
</article>
<article>
<h2>Make it yours</h2>
<h2>Appearance</h2>
<p>
Choose your theme, wallpaper, colors, and motion. Change settings
through the app or a KDL config, with live reload.
@@ -118,4 +116,4 @@
</footer>
</body>
</html>
</html>