Skip to content
BeyondMagicPublic

About

Widget Interface & Shell Platform.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

WISP logotype

WISP

A minimalist desktop shell for Wayland, built with Quickshell and designed to run alongside Hyprland.

Overview

WISP is a desktop shell built around pure black surfaces, high-contrast typography, and opacity-based hierarchy.

Repository Structure

  • .template.json: Template version manifest tracking upstream repository and managed scaffolding paths.
  • CHANGELOG.md: History of template releases and additions following Keep a Changelog.
  • AGENTS.md: Instructions, writing rules, glossary conventions, and workflow standards for AI coding agents and contributors.
  • .agents/skills/: Agent skills for requirements interviewing (grill-me) and clear technical writing (humanizer).
  • documentation/: Zensical documentation site containing the project Glossary, Decision Records, Feature Records, and Metrics & Results.
  • source/: Root directory for Quickshell QML modules and shell source code.
  • tests/: Root directory for automated unit and integration test suites.

Documentation

Full project documentation, architectural decision records, and feature specifications are available on the documentation site:

Local Preview

To run the documentation server locally:

cd documentation
zensical serve          # Live preview on http://localhost:8000
zensical build --clean  # Static build (must pass with 0 warnings)

To start the shell with Quickshell:

quickshell -p source

Checking Template Updates

Consumer projects can check whether the template scaffolding is current:

  1. Inspect the installed version in .template.json.
  2. Compare with upstream releases:
    git ls-remote --tags https://github.com/BeyondMagic/swe-template
  3. Review CHANGELOG.md and apply scaffolding updates according to the protocol in AGENTS.md.

License

GNU Affero General Public License v3.0 (AGPL-3.0-or-later).

About

Widget Interface & Shell Platform.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Contributors

Languages