Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

How to Contribute to bspwm-wiki

bspwm-wiki exists to make bspwm understandable, not just configurable. Contributions that improve clarity, correctness, and learning are always welcome. You don’t need to be an expert to contribute - even small improvements help.

What You Can Contribute

You can help bspwm-wiki in many ways:

  • Fix typeos or unclear explanations
  • Improve wording for beginners
  • Add examples that explain why, not just how
  • Expand existing sections with missing details
  • Suggest new sections or topics
  • Share debugging tips or common pitfalls If something confused you while learning bspwm, that’s probably worth documenting.

What bspwm-wiki Values

Before contributing, keep these principles in mind:

  1. Explain concepts, not just commands
  2. Prefer reasoning over copy-paste solutions
  3. Assume the reader is curious, not careless
  4. Keep a neutral, respectful tone
  5. Make sure that your content has clarity

Warning

bspwm-wiki aims to reduce blind config copying, not encourage it. But this documentation shall include some configuration files and references purely for learning purposes.

How to contribute

  1. Fork the repository from github : rdbhvr-001/bspwm-wiki
  2. Create a new branch for your change in that forked repository
  3. Install rust mdbook for documentation by the following commands
# Make sure that you have cargo and rust installed. A simple surf in web can help you install them.
# Install mdbook via cargo

cargo install mdbook

# Make sure to add cargo to your PATH
  1. Learn how to use mdbook.
  2. In the forked repository, you will find SUMMARY.md file and other md files inside src directory, which is basically the index and source for bspwm-wiki, follow the instructions given in step 4.
  3. After editting the markdown files or adding new ones, you can use the following command to generate the book from the project root dir.
# To test it in your friendly local browser test with
mdbook serve

# To build the book, in the terminal typeos
mdbook build

# The book is compiled to html and is in `./book` directory.
  1. Rename the ./book to ./docs
  2. Open up a pull request after testing the book locally in browser

Tip

An Easier Way to Contribute : You can click that edit source button on the navbar near print button to directly edit the source, make a pull request and make changes.