labwc / labwc/labwc.github.io

Some more content suggestions

Open
#31 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
HTML
Stars
2
Forks
11
Avg merge
1h 55m
Merged PRs (30d)
1

Description

Tips / Tricks and / or Getting started, Keyboard Layout:

FAQ

  • Add Print for screenshot use-case (grim -g "`slurp`")
  • Add XF86PowerOff for logout manager use-case (wlogout?)
  • how to adjust "dynamic" env vars like PATH, e.g.
    • inherit environment, so setting it before starting labwc
    • having it in .bashrc might require using bash -i -c in the keybind, at least on some distros (Debian when not restarting labwc after changes to .bashrc)
    • having it in .profile might require using sh -l in the keybind, depending on how labwc was started
      • if the env var is already set when starting labwc the -l argument is not required because labwc (and thus the Execute action) inherits its startup environment
    • ..
  • The Execute action doesn't use a shell, how to use && and similar things in a keybind
    • easiest solution: external script which then gets called via the keybind
    • prefixing the command by sh -c like sh -c "command 1; command 2;"
    • due to the XML nature of the config file, some characters have to be escaped, like & -> & or > -> >
  • How to force a specific output for applications: https://github.com/labwc/labwc/discussions/1136#discussioncomment-7214447
  • https://labwc.github.io/faq.html#server-side-decoration misses a * window rule with serverDecoration="no"

Meta:

  • Mention the possibility to update the website via this repo (directly on the landing page?)

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with faq.html and the sections named in the issue, including Tips / Tricks, Getting started, Keyboard Layout, and Meta; check the landing page for the website-update note. Review the linked labwc and sway references before adding the requested guidance for keyboard layouts, screenshots, environment variables, Execute actions, output selection, and server decorations. Done means the checklist items are addressed in the appropriate pages and the links and examples render correctly.

Written by the indexing model from the issue text.

Assessment

Tech stack
html, shell, xml
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.