Simplify documentation and website; expand shortcut guides
This commit is contained in:
Samuel Onoja committed
1 parent
46509f880a
commit
4d60c296a7
26 files changed
+1060
-1032
No files matched your search
+1
-3
@@ -2,7 +2,6 @@
|
||||
|
||||
The public site is static HTML and CSS. The handbook is generated from the
|
||||
project's Markdown guides, so website and repository documentation stay in sync.
|
||||
There are no client frameworks, external fonts, or tracking scripts.
|
||||
|
||||
## Local preview
|
||||
|
||||
@@ -18,8 +17,7 @@ site sources or Markdown guides, then refresh the browser.
|
||||
|
||||
- `site/index.html` and `site/styles.css`: homepage and shared visual design.
|
||||
- `site/content/index.md`: handbook introduction.
|
||||
- `docs/{why-ferese,installation,configuration,desktop-widgets,notifications,locking,screen-sharing}.md`:
|
||||
source guides.
|
||||
- `docs/*.md`: guides; published pages are listed in `scripts/build-site.py`.
|
||||
- `scripts/build-site.py`: renders Markdown, resolves links, generates section
|
||||
navigation, previous/next links, and the search index.
|
||||
- `site/app.js`: handbook search and code copying. Reading and navigation work
|
||||
|
||||
+33
-49
@@ -1,69 +1,53 @@
|
||||
# The Ferese handbook
|
||||
# Ferese handbook
|
||||
|
||||
Ferese is a complete Wayland desktop built around personalization. Its custom shell, native Settings, live themes, and flexible layouts work together as one cohesive experience.
|
||||
Ferese is a Linux Wayland desktop with scrolling columns, tree tiling, floating
|
||||
windows, and a shared theme for its desktop tools.
|
||||
|
||||
This handbook covers installing Ferese, finding your way around, and making the desktop your own.
|
||||
## Get started
|
||||
|
||||
[Why Ferese](why-ferese.md) explains why the desktop is designed as one integrated system rather than assembled from separately configured tools.
|
||||
|
||||
## Start with your first session
|
||||
|
||||
1. Read [Installation](installation.md) for dependencies, building, login-manager or TTY startup, and recovery.
|
||||
1. [Install Ferese](installation.md), or try a [nested preview](installation.md#preview-and-logs).
|
||||
2. Open **Control Center → Settings** to choose a theme and configure your desktop.
|
||||
3. Explore the [configuration reference](configuration.md) for layouts, shortcuts, window rules, and displays.
|
||||
3. Use the [configuration reference](configuration.md) for shortcuts, gestures, window rules, and displays.
|
||||
|
||||
Want to try it before switching desktops? The [preview instructions](installation.md#preview-and-logs) cover running Ferese inside an existing Wayland session.
|
||||
## Default shortcuts
|
||||
|
||||
## Find your way around
|
||||
|
||||
Ferese supports scrolling columns, tree tiling, floating windows, and a workspace overview. These are the built-in keyboard shortcuts; all can be changed in Settings.
|
||||
`Super` is usually the Windows key. All these shortcuts can be changed in Settings.
|
||||
|
||||
| Shortcut | Action |
|
||||
| --- | --- |
|
||||
| Super + Enter | Open a terminal |
|
||||
| Super + H / J / K / L | Focus a window |
|
||||
| Super + R | Cycle column width |
|
||||
| Super + Tab | Open workspace and window overview |
|
||||
| Super + H / J / K / L | Focus left / down / up / right |
|
||||
| Super + F | Maximize the window |
|
||||
| Super + Shift + F | Toggle fullscreen |
|
||||
| Super + Tab | Open overview |
|
||||
| Super + M | Switch scrolling / tree layout |
|
||||
| Print Screen | Capture the active monitor and open Satty |
|
||||
| Super + Shift + S | Select a screenshot area |
|
||||
| Super + Shift + E | Ask to log out |
|
||||
|
||||
Three-finger swipes move between workspaces and windows. Open **Control Center → Settings → Shortcuts** to change the defaults or assign gestures to other actions.
|
||||
See [all shortcuts and mouse actions](shortcuts.md), including Super-drag to move
|
||||
and Super-right-drag to resize floating windows.
|
||||
|
||||
## Make it feel like yours
|
||||
Three-finger swipes up/down switch workspaces; left/right focus windows.
|
||||
Change gestures in **Settings → Shortcuts**. The login shortcut guide can be
|
||||
disabled there too.
|
||||
|
||||
Use **Settings** for everyday customization. Choose an appearance preset, change the wallpaper, adjust shell and window corners, or add a clock and sticky notes through [Desktop widgets](desktop-widgets.md).
|
||||
## Desktop guides
|
||||
|
||||
[Native locker](locking.md) covers lock-screen appearance, authentication, and idle locking.
|
||||
- [Desktop widgets](desktop-widgets.md): clocks and sticky notes.
|
||||
- [Notifications](notifications.md): history and Do Not Disturb.
|
||||
- [Lock screen](locking.md): appearance, automatic locking, and display sleep.
|
||||
- [Screen sharing and recording](screen-sharing.md): share an app or display, or save a video.
|
||||
- [Desktop portals](portals.md): integration with applications.
|
||||
|
||||
[Notifications](notifications.md) explains popup cards, history, Do Not Disturb, and app actions.
|
||||
Use Settings or edit `~/.config/ferese/config.kdl`. Changes reload automatically;
|
||||
invalid edits keep the last working configuration.
|
||||
|
||||
If you prefer a text editor, your configuration lives at:
|
||||
## Troubleshooting
|
||||
|
||||
```text
|
||||
~/.config/ferese/config.kdl
|
||||
```
|
||||
See [logs and recovery](installation.md#logout-and-recovery). `feresectl exit`
|
||||
ends the session immediately; `feresectl request-logout` asks for confirmation.
|
||||
|
||||
Ferese reloads changes as you make them. An invalid edit keeps the last working configuration. Settings also preserves a backup of your previous save. See [Saving and validation](configuration.md#saving-and-validation).
|
||||
|
||||
## Share your screen
|
||||
|
||||
Use Ferese’s native display picker to share a monitor with a portal-compatible
|
||||
recording or conferencing app. To save a video directly, click the recording
|
||||
icon in the top bar. See [Screen sharing and recording](screen-sharing.md) for setup, stopping a session, and supported sources.
|
||||
|
||||
## Keep a recovery path
|
||||
|
||||
Keep another desktop session available while testing hardware behavior. Save your work before logging out: `feresectl exit` and **Super + Shift + E** end the current session immediately.
|
||||
|
||||
The [recovery guide](installation.md#logout-and-recovery) explains logs, installed releases, and rollback.
|
||||
|
||||
## Work on Ferese
|
||||
|
||||
Ferese is built in Rust on Smithay. Use release builds when evaluating motion and startup performance. From the repository checkout:
|
||||
|
||||
```sh
|
||||
cargo test --workspace --locked
|
||||
cargo fmt --all --check
|
||||
```
|
||||
|
||||
The [source repository](https://github.com/ferese-wm/ferese) is the place to explore implementation details and report issues. When reporting a problem, include how to reproduce it, whether you used the nested or DRM backend, and relevant logs.
|
||||
Report problems in the [issue tracker](https://github.com/ferese-wm/ferese/issues).
|
||||
Include reproduction steps, whether Ferese ran as a nested preview or a direct
|
||||
session, and relevant logs. Contributors can start with [Development](development.md).
|
||||
+12
-12
@@ -6,15 +6,15 @@
|
||||
<meta name="theme-color" content="#10151c" />
|
||||
<meta
|
||||
name="description"
|
||||
content="Ferese is a beautiful, fluid Wayland desktop made to feel like yours. Explore the desktop, then get started with the documentation."
|
||||
content="Ferese is a Linux Wayland desktop with scrolling layouts, native Settings, and a shared theme."
|
||||
/>
|
||||
<meta
|
||||
property="og:title"
|
||||
content="Ferese — A desktop that feels like yours"
|
||||
content="Ferese — Wayland desktop"
|
||||
/>
|
||||
<meta
|
||||
property="og:description"
|
||||
content="A complete Wayland desktop built around personalization."
|
||||
content="A Wayland desktop with scrolling layouts and a shared theme."
|
||||
/>
|
||||
<meta property="og:type" content="website" />
|
||||
<meta
|
||||
@@ -22,7 +22,7 @@
|
||||
content="https://ferese-wm.github.io/ferese/assets/ferese-desktop.png"
|
||||
/>
|
||||
<meta name="twitter:card" content="summary_large_image" />
|
||||
<title>Ferese — A desktop that feels like yours</title>
|
||||
<title>Ferese — Wayland desktop</title>
|
||||
<link rel="icon" href="assets/ferese.svg" type="image/svg+xml" />
|
||||
<link rel="stylesheet" href="styles.css?v=jetbrains" />
|
||||
</head>
|
||||
@@ -47,11 +47,11 @@
|
||||
<main id="main" class="simple-home">
|
||||
<section class="product-intro page-width">
|
||||
<h1 class="product-tagline">
|
||||
A beautiful, fluid Wayland desktop made to feel like yours.
|
||||
A Wayland desktop with scrolling layouts and a shared theme.
|
||||
</h1>
|
||||
<p class="product-description">
|
||||
A complete Linux desktop with a custom shell, native settings,
|
||||
scrolling and tiling layouts, and live-reloading themes.
|
||||
A Linux desktop with a top bar, Settings,
|
||||
scrolling and tiling layouts, and themes that update live.
|
||||
</p>
|
||||
<div class="product-links">
|
||||
<a class="button" href="docs/installation.html">Install Ferese</a>
|
||||
@@ -93,7 +93,7 @@
|
||||
A menu bar, Control Center, Settings, notifications, and desktop
|
||||
widgets, designed to work together.
|
||||
</p>
|
||||
<a href="docs/why-ferese.html">Why integration matters →</a>
|
||||
<a href="docs/why-ferese.html">Explore Ferese →</a>
|
||||
</article>
|
||||
<article>
|
||||
<h2>Make it yours</h2>
|
||||
@@ -108,7 +108,7 @@
|
||||
<h2>Getting started</h2>
|
||||
<p>
|
||||
The <a href="docs/installation.html">installation guide</a> covers
|
||||
dependencies, setup with any Wayland-capable login manager, and TTY startup. You can also
|
||||
dependencies, login, updates, and recovery. You can also
|
||||
<a href="docs/installation.html#preview-and-logs">preview Ferese</a>
|
||||
inside an existing Wayland session before installing.
|
||||
</p>
|
||||
@@ -116,17 +116,17 @@
|
||||
Share a display with recording and conferencing apps through Ferese’s
|
||||
native screen-sharing portal. Choose what to share and stop at any time.
|
||||
See <a href="docs/screen-sharing.html">screen sharing and recording</a>
|
||||
for setup and current capabilities.
|
||||
for setup and limits.
|
||||
</p>
|
||||
<p>
|
||||
Built in Rust on Smithay. Development happens
|
||||
Find <a href="docs/shortcuts.html">shortcuts and mouse actions</a> in the handbook. Development happens
|
||||
<a href="https://github.com/ferese-wm/ferese">on GitHub</a>.
|
||||
</p>
|
||||
</section>
|
||||
</main>
|
||||
<footer class="site-footer page-width">
|
||||
<a class="wordmark" href="./">ferese</a>
|
||||
<p>A beautiful, fluid Wayland desktop.</p>
|
||||
<p>A Wayland desktop with scrolling layouts.</p>
|
||||
<a href="docs/">Read the handbook <svg class="link-arrow" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.8" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true" focusable="false"><path d="M7 17 17 7M7 7h10v10"/></svg></a>
|
||||
</footer>
|
||||
</body>
|
||||
|
||||
Reference in new issue
Block a user