aria/feresaria
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Publish topic guides to the wiki and document tabbed windows

Browse Source 
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 2026-10-13 00:32:23 +01:00
1 parent eaeabebe73
commit eb84104940
37 files changed
+2178 -1510
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

site/README.md
+10 -14
View File
@@ -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