New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation #645

Open
madnight opened this Issue May 17, 2017 · 6 comments

Comments

Projects
None yet
5 participants
@madnight

madnight commented May 17, 2017

@neeasade

This comment has been minimized.

Contributor

neeasade commented May 22, 2017

Is the end goal with this issue a user guide?

@madnight

This comment has been minimized.

madnight commented May 22, 2017

@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.

@madnight

This comment has been minimized.

madnight commented May 25, 2017

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
madnight@dd62c15

Result: https://madnight.github.io/bspwm/

@Jameskr97

This comment has been minimized.

Jameskr97 commented Jul 16, 2017

@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.

@baskerville

This comment has been minimized.

Owner

baskerville commented Jul 16, 2017

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.

@badele

This comment has been minimized.

badele commented Mar 1, 2018

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 animated or the documentation result

The project available here

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment