Fix modal keyboard navigation and title switches; refresh documentation
This commit is contained in:
1 parent
1b665f4157
commit
67d2d95a01
9 files changed
+312
-192
No files matched your search
+14
-12
@@ -1,7 +1,8 @@
|
||||
# Ferese website and handbook
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
## Local preview
|
||||
|
||||
@@ -12,8 +13,9 @@ python3 -m venv .site-venv
|
||||
python3 -m http.server 8080 --bind 127.0.0.1 --directory build/site
|
||||
```
|
||||
|
||||
Open http://localhost:8080 or http://localhost:8080/docs/. Rebuild after editing
|
||||
site sources or Markdown guides, then refresh the browser.
|
||||
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.
|
||||
|
||||
- `site/index.html` and `site/styles.css`: homepage and shared visual design.
|
||||
- `site/content/index.md`: handbook introduction.
|
||||
@@ -25,13 +27,13 @@ site sources or Markdown guides, then refresh the browser.
|
||||
|
||||
## GitHub Pages
|
||||
|
||||
Select **Settings → Pages → Source → GitHub Actions**. The Pages workflow
|
||||
publishes site and documentation changes pushed to `main`, or can run manually.
|
||||
Expected URL: https://ferese-wm.github.io/ferese/.
|
||||
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/.
|
||||
|
||||
Local links are relative, including documentation search, so publishing under
|
||||
the `/ferese/` project path works. Screenshots are copied from `docs/images`
|
||||
during the build; the generated `build/site` directory is ignored by Git.
|
||||
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
|
||||
`build/site`, which is ignored by Git.
|
||||
|
||||
See [GitHub's custom workflow documentation](https://docs.github.com/en/pages/getting-started-with-github-pages/using-custom-workflows-with-github-pages)
|
||||
for deployment setup.
|
||||
For deployment setup, follow [GitHub’s custom workflow
|
||||
documentation](https://docs.github.com/en/pages/getting-started-with-github-pages/using-custom-workflows-with-github-pages).
|
||||
+18
-13
@@ -1,9 +1,11 @@
|
||||
# Ferese handbook
|
||||
|
||||
Ferese is a Linux Wayland desktop with scrolling columns, tree tiling, floating
|
||||
windows, and a shared theme for its desktop tools.
|
||||
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.
|
||||
|
||||
[Browse screenshots](screenshots.md) of the desktop, themes and shell controls.
|
||||
[Browse screenshots](screenshots.md) to see the themes, layouts and desktop controls in
|
||||
use
|
||||
|
||||
## Get started
|
||||
|
||||
@@ -13,7 +15,8 @@ windows, and a shared theme for its desktop tools.
|
||||
|
||||
## Default shortcuts
|
||||
|
||||
`Super` is usually the Windows key. All these shortcuts can be changed in Settings.
|
||||
Use `Super`, usually the Windows key, for the shortcuts below, and make them your own in
|
||||
**Settings → Shortcuts**.
|
||||
|
||||
| Control | Action |
|
||||
| --- | --- |
|
||||
@@ -32,8 +35,8 @@ windows, and a shared theme for its desktop tools.
|
||||
| Three-finger swipe left / right | Focus the window to the right / left |
|
||||
| Login shortcut guide | Appears at login; disable in Settings → Shortcuts |
|
||||
|
||||
See [all shortcuts and mouse actions](shortcuts.md), including Super-drag to move
|
||||
and Super-right-drag to resize floating windows.
|
||||
The [shortcuts and mouse actions guide](shortcuts.md) covers the rest, including how to
|
||||
group windows, resize them and move between workspaces.
|
||||
|
||||
## Desktop guides
|
||||
|
||||
@@ -43,14 +46,16 @@ and Super-right-drag to resize floating windows.
|
||||
- [Screen sharing and recording](screen-sharing.md): share an app or display, or save a video.
|
||||
- [Desktop portals](portals.md): integration with applications.
|
||||
|
||||
Use Settings or edit `~/.config/ferese/config.kdl`. Changes reload automatically;
|
||||
invalid edits keep the last working configuration.
|
||||
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.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
See [logs and recovery](installation.md#logout-and-recovery). `feresectl exit`
|
||||
ends the session immediately; `feresectl request-logout` asks for confirmation.
|
||||
If you need to end a session, `feresectl request-logout` asks for confirmation and
|
||||
`feresectl exit` exits immediately, so save your work first. The [logs and recovery
|
||||
guide](installation.md#logout-and-recovery) helps when something stops responding.
|
||||
|
||||
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).
|
||||
You can [report a problem](https://github.com/ferese-wm/ferese/issues) with 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.
|
||||
Reference in new issue
Block a user