Open madnight opened 7 years ago
Is the end goal with this issue a user guide?
@neeasade anything like this https://i3wm.org/docs/
It don't have to be sooo nice documented (no need for screenshots and hundred of examples), but a basic version of that (10-20%) would be the required minimum. A simple list of all commands with a short desc (that is provided through the man page) is not enough.
I would start the documenation as gh-page branch on github allowing for free github hosting (bswpm.github.io) and collaborative documenation in markdown syntax.
As for example https://www.slant.co/versus/1290/6620/~i3_vs_bspwm many people like i3 because it has an excellent documenation, i3 lacks gaps, so people are willing to install a fork called i3-gaps instead of switching to bspwm that allows for even better gaps settings.
I created a basic example with mkdocs
The setup is very simple i called mkdocs new bspwm
edited the mkdocs.yml to link into doc folder and executed mkdocs gh-deploy
https://github.com/madnight/bspwm/commit/dd62c15055027e6885e72e47acd74ef2e366413e
@baskerville I wanted to add some wiki pages. I was going to start by moving things from the doc/ folder to the wiki, but one question I have is, what is the difference between a domain and a command? I looked through the man page, and they seem like two names referencing the same thing.
Yes: the two terms refer to the first argument given to bspc
.
In the original spec, the first argument was called command.
But I recently introduced the term domain, because, in the following example: node --close
, the command is --close
, not node
. So node
is a collection of commands acting on similar objects, and I'm calling that a domain.
I think query
, config
, subscribe
and quit
can be considered commands, and everything else is a domain.
Hi,
I have begined a project that generate automatically a bspwm documentation. Actually, i have made a new project, i don't know if legitimate include in the main bspwm project.
You can see the animated result or the documentation result
The project available here
+1 Really missing some good documentation for the config and all the bspc commands
Hello, there.
I wrote an exploration article on bspwm a while back. Many people have found this helpful from what I understand. And, one of them urged me to draw attention to it on this and this issues. Also, someone already started translating the article in Spanish which I just found out today.
Additionally, I also planned to write two more parts, but never found the time to articulate and design those. Lastly, this is for the documentors that are going to write a i3-like documentation website. may this help you.
Thanks.
This will probably be buried... given how old this issue and comment is.
you could start to copy some docs together like:
https://wiki.archlinux.org/index.php/Bspwm
https://github.com/IntrepidPig/bspwm-doc/blob/master/getting-started.md