From f5b5c5095398e12934d336ec6fc06143effdcbb8 Mon Sep 17 00:00:00 2001 From: LGUG2Z Date: Tue, 20 Jan 2026 19:19:15 -0800 Subject: [PATCH] feat(usage): add expectations, some placeholders in workspaces --- astro.config.mjs | 7 +++-- src/content/docs/about/expectations.mdx | 42 +++++++++++++++++++++++++ src/content/docs/usage/workspaces.mdx | 14 +++++++++ 3 files changed, 60 insertions(+), 3 deletions(-) create mode 100644 src/content/docs/about/expectations.mdx diff --git a/astro.config.mjs b/astro.config.mjs index 654a41c5..43400f60 100644 --- a/astro.config.mjs +++ b/astro.config.mjs @@ -31,6 +31,7 @@ export default defineConfig({ { label: "Community", slug: "about/community" }, { label: "Licensing", slug: "about/licensing" }, { label: "Sponsorship", slug: "about/sponsorship" }, + { label: "Expectations", slug: "about/expectations" }, ], }, { @@ -50,9 +51,9 @@ export default defineConfig({ { label: "Usage", items: [ - { label: "Windows", slug: "usage/windows" }, // focusing, moving, resizing - { label: "Containers", slug: "usage/containers" }, // stacking - { label: "Workspaces", slug: "usage/workspaces" }, // send-to / move-to, padding, offsets, layouts, layout flips + { label: "Windows", slug: "usage/windows" }, + { label: "Containers", slug: "usage/containers" }, + { label: "Workspaces", slug: "usage/workspaces" }, // padding, offsets, layouts, layout flips { label: "Monitors", slug: "usage/monitors" }, // send-to / move-to, padding, offsets, move behavior { label: "Layers", slug: "usage/layers" }, // floating vs tiling layer { label: "Borders", slug: "usage/borders" }, // borders and colors diff --git a/src/content/docs/about/expectations.mdx b/src/content/docs/about/expectations.mdx new file mode 100644 index 00000000..ff3f7dae --- /dev/null +++ b/src/content/docs/about/expectations.mdx @@ -0,0 +1,42 @@ +--- +title: Expectations +description: Setting Expectations +tableOfContents: false +--- + +## The Software + +komorebi exists first and foremost to address my own needs, and as such it is built primarily according to my personal preferences; I don't care if i3 does something this way, or hyprland does something that way - komorebi will always do things my way. + +komorebi is built on top of limited public APIs exposed by closed operating systems - it will likely never be as flashy as the window managers and desktop environments you will find on Linux. + +I work on komorebi and provide support to users in my own time, at my own pace. + +komorebi is not an open source project and I am not an open source software developer, so you should check any remnants of the open source culture of dehumanizing software maintainers at the door when you enter any komorebi community spaces. + +This also applies if you have purchased an Individual Commercial Use License; you have purchased a license to use the software for commercial use _in the current state and as it is provided_. Nothing more, nothing less. + +## Contributions + +There have been a number of contributors to komorebi over the years, and contributions are accepted under the [Zero-Clause BSD License](https://www.tldrlegal.com/license/bsd-0-clause-license). + +However, these days I am quite conservative when it comes to accepting contributions from new contributors due to the scale and scope of the project, the ubiquity and questionable quality of LLM-generated code, and the potential blast radius for breaking changes. + +If you would like to contribute code to the project, please speak to me first on Discord in the `#development` channel instead of opening a drive-by PR. + +## Support + +Support is provided on a best-effort basis by myself and other volunteers in the community. + +A lot of effort has gone into automatically generating correct and up-to-date documentation for komorebi's configuration schema and komorebic's CLI commands. + +Providing support is by far the most time-consuming aspect of this project, so please make sure you exhaust all of the available documentation resources first _before_ reaching out to the community for support. + +This means doing basic things like: + +- Following the quickstart guides when you install the software +- Ensuring your configuration files contain valid JSON +- Validating your configurations against the provided JSONSchema files +- Searching through komorebic commands and reading the usage documentation + +If and when you do reach out to the community for support, please be kind, be patient, and be respectful. diff --git a/src/content/docs/usage/workspaces.mdx b/src/content/docs/usage/workspaces.mdx index 9d792e9a..a4c74916 100644 --- a/src/content/docs/usage/workspaces.mdx +++ b/src/content/docs/usage/workspaces.mdx @@ -42,3 +42,17 @@ Workspaces can be moved to other monitors in the following ways. ### By Focus and Index The focused workspace can be moved to a monitor identified by an index using the command. + +## Layouts +### Layout Rules +TODO + +## Padding +### Workspace Padding +### Container Padding + +TODO + +## Offsets + +TODO