Publish topic guides to the wiki and document tabbed windows
Publish the guides from this repository to the GitHub Wiki. Organize them into Usage, Configuration and Development, with 15 separate configuration topics and redirects for the former website guide URLs. Add a tabbed-windows guide covering grouping, switching tabs and taking windows out. Document the scrolling indicator's defaults and limits, and link the guide from the README, shortcuts and IPC pages. Update from main, including the latest tabbed-layout changes. Separate Activities setup, configuration and publishing documentation. Review the guide prose with the unslop skill, keeping existing examples and heading links. The wiki workflow uses GitHub's built-in token to publish documentation changes on main. Validation: - 20 documentation tests pass, including README links and Activities/tab-indicator field coverage. - The publisher builds 46 wiki pages; the site build and Python syntax checks pass. - All 115 code examples from main are preserved. - The Python suite passes: 90 tests passed and 31 opt-in integration tests skipped, with the system GI module available.
This commit is contained in:
Samuel Onoja authored and GitHub committed
1 parent
eaeabebe73
commit
eb84104940
37 files changed
+2178
-1510
No files matched your search
+10
-14
@@ -1,7 +1,7 @@
|
||||
# Ferese website and handbook
|
||||
# Ferese website
|
||||
|
||||
The website's handbook is built from the project's Markdown guides, so the website
|
||||
and repository share the same documentation.
|
||||
The website links to the [GitHub Wiki](https://github.com/ferese-wm/ferese/wiki)
|
||||
for documentation. Former handbook URLs redirect to the matching wiki pages.
|
||||
|
||||
## Local preview
|
||||
|
||||
@@ -12,18 +12,14 @@ python3 -m venv .site-venv
|
||||
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. Rebuild and refresh the browser after changing the site sources or guides.
|
||||
Open http://localhost:8080 for the homepage. Rebuild and refresh the browser
|
||||
after changing the site sources.
|
||||
|
||||
- `site/index.html` and `site/home.css`: homepage and desktop screenshots.
|
||||
- `site/styles.css`: shared dark appearance, typography and navigation.
|
||||
- `site/handbook.css`: handbook layout, search and reference tables.
|
||||
- `site/content/index.md`: handbook introduction.
|
||||
- `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
|
||||
without JavaScript. Search is local to the browser, with no third-party service.
|
||||
- `docs/*.md` and its configuration/development topic directories: guide sources published to the wiki.
|
||||
- `scripts/build-site.py`: copies homepage assets and writes handbook redirects.
|
||||
- `scripts/build-wiki.py`: validates and generates wiki pages.
|
||||
|
||||
## GitHub Pages
|
||||
|
||||
@@ -32,8 +28,8 @@ open **Actions → Deploy website to GitHub Pages → Run workflow** and choose
|
||||
branch to publish. Deployment runs manually, and 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
|
||||
The homepage uses relative asset links, so it also works under the `/ferese/`
|
||||
project path. Each build copies screenshots from `docs/images` into
|
||||
`build/site`, which is ignored by Git.
|
||||
|
||||
For deployment setup, follow [GitHub’s custom workflow
|
||||
|
||||
+6
-6
@@ -28,15 +28,15 @@
|
||||
<header class="site-header">
|
||||
<div class="header-inner page-width">
|
||||
<a class="brand" href="#main" aria-label="Ferese home"><img src="assets/branding/ferese.svg" width="34" height="34" alt=""><span>Ferese</span></a>
|
||||
<nav aria-label="Main navigation"><a href="#make-room">The desktop</a><a href="#appearance">Appearance</a><a href="docs/">Handbook</a></nav>
|
||||
<div class="header-actions"><a class="small-button" href="docs/installation.html">Get Ferese</a></div>
|
||||
<nav aria-label="Main navigation"><a href="#make-room">The desktop</a><a href="#appearance">Appearance</a><a href="https://github.com/ferese-wm/ferese/wiki">Documentation</a></nav>
|
||||
<div class="header-actions"><a class="small-button" href="https://github.com/ferese-wm/ferese/wiki/Installation">Get Ferese</a></div>
|
||||
</div>
|
||||
</header>
|
||||
<main id="main">
|
||||
<section class="hero page-width" aria-labelledby="hero-title">
|
||||
<h1 id="hero-title">A little more room.</h1>
|
||||
<p class="hero-description">A configurable Wayland desktop for Linux that brings your windows and everyday controls together.</p>
|
||||
<div class="hero-actions"><a class="primary-button" href="docs/installation.html">Get Ferese <svg class="icon"><use href="#i-arrow"/></svg></a><a class="inline-link" href="#desktop-preview">Take a look <svg class="icon down"><use href="#i-arrow"/></svg></a></div>
|
||||
<div class="hero-actions"><a class="primary-button" href="https://github.com/ferese-wm/ferese/wiki/Installation">Get Ferese <svg class="icon"><use href="#i-arrow"/></svg></a><a class="inline-link" href="#desktop-preview">Take a look <svg class="icon down"><use href="#i-arrow"/></svg></a></div>
|
||||
<div class="desktop-stage" id="desktop-preview">
|
||||
<div class="desktop-capture" id="desktop-capture">
|
||||
<img id="desktop-capture-image" src="assets/screenshots/ferese-media.webp" srcset="assets/screenshots/ferese-media-960.webp 960w, assets/screenshots/ferese-media-1440.webp 1440w, assets/screenshots/ferese-media.webp 2880w" sizes="(max-width: 700px) calc(100vw - 40px), (max-width: 1200px) calc(100vw - 80px), 1120px" width="2880" height="1800" alt="The Ferese desktop with a translucent Now Playing popup showing Spotify artwork and playback controls over the blue and violet city wallpaper." fetchpriority="high">
|
||||
@@ -61,9 +61,9 @@
|
||||
<h3>A little closer to your music.</h3><p>See what's playing and pause or skip a track, right from your panel.</p>
|
||||
</article>
|
||||
</section>
|
||||
<div class="gallery-link page-width"><a class="inline-link" href="docs/screenshots.html">See all desktop screenshots <svg class="icon"><use href="#i-arrow"/></svg></a></div>
|
||||
<section class="start-section page-width" aria-labelledby="start-title"><img class="start-logo" src="assets/branding/ferese.svg" width="74" height="74" alt=""><h2 id="start-title">Make yourself at home.</h2><p>Try Ferese in a nested session, or install it as your next desktop.</p><div class="hero-actions"><a class="primary-button" href="docs/installation.html">Get Ferese <svg class="icon"><use href="#i-arrow"/></svg></a><a class="inline-link" href="https://github.com/ferese-wm/ferese">Explore the source <svg class="icon"><use href="#i-external"/></svg></a></div></section>
|
||||
<div class="gallery-link page-width"><a class="inline-link" href="https://github.com/ferese-wm/ferese/wiki/Screenshots">See all desktop screenshots <svg class="icon"><use href="#i-arrow"/></svg></a></div>
|
||||
<section class="start-section page-width" aria-labelledby="start-title"><img class="start-logo" src="assets/branding/ferese.svg" width="74" height="74" alt=""><h2 id="start-title">Make yourself at home.</h2><p>Try Ferese in a nested session, or install it as your next desktop.</p><div class="hero-actions"><a class="primary-button" href="https://github.com/ferese-wm/ferese/wiki/Installation">Get Ferese <svg class="icon"><use href="#i-arrow"/></svg></a><a class="inline-link" href="https://github.com/ferese-wm/ferese">Explore the source <svg class="icon"><use href="#i-external"/></svg></a></div></section>
|
||||
</main>
|
||||
<footer class="site-footer page-width"><a class="brand" href="#main" aria-label="Ferese home"><img src="assets/branding/ferese.svg" width="28" height="28" alt=""><span>Ferese</span></a><span>Built in the open for Linux.</span><nav aria-label="Footer navigation"><a href="docs/">Handbook</a><a href="https://github.com/ferese-wm/ferese">GitHub <svg class="icon"><use href="#i-external"/></svg></a></nav></footer>
|
||||
<footer class="site-footer page-width"><a class="brand" href="#main" aria-label="Ferese home"><img src="assets/branding/ferese.svg" width="28" height="28" alt=""><span>Ferese</span></a><span>Built in the open for Linux.</span><nav aria-label="Footer navigation"><a href="https://github.com/ferese-wm/ferese/wiki">Documentation</a><a href="https://github.com/ferese-wm/ferese">GitHub <svg class="icon"><use href="#i-external"/></svg></a></nav></footer>
|
||||
</body>
|
||||
</html>
|
||||
Reference in new issue
Block a user