search

bisq-network / wiki

@bisq-network documentation at https://bisq.wiki
Other
13 stars 8 forks source link

Create style guidelines article #9

Closed cbeams closed 4 years ago

cbeams commented 4 years ago

From a conversation between @m52go and @cbeams at https://github.com/bisq-network/projects/issues/6#issuecomment-586901368:

Is there any place we can put wiki contribution guidelines/suggestions? Maybe just create a new page for it?

Just a new page is fine for a start. See

for reference. Perhaps a page simply titled https://bisq.wiki/Guidelines would be fine for now, simply listing out the various guidelines and rules we'd like to establish.

I'm particularly interested in specifying that screenshots should omit the OS window border, since everyone runs something different

True, but in my experience, the convenience of CMD-SHIFT-4-SPACE whole-window screenshots on macOS are important. And they look very attractive because they capture the drop shadow. I'm not opposed to a style guideline that says that all such screenshots should crop out window trim and shadows, but I'm not sure the end result will actually be better for it. If someone does a guide from ubuntu and captures the look and feel there, and most others do it from macOS, it's not the biggest deal to me personally. Also, some articles may include screenshots of non-Bisq windows, e.g. finder/explorer windows, and there is no way to hide the os-specificity there. Again, I don't have a very strong opinion on this.

and to use the same template for all arrows (I have one I've used for all arrows on docs.bisq.network).

Seems like a good idea. Just wonder if there's actually a common toolset that people will be able to use. I've always liked using Skitch for quickly marking up screenshots. But whatever you see fit.

cbeams commented 4 years ago

As mentioned in the screencast at bisq-network/wiki#16, I've just created https://bisq.wiki/Wiki_style_guidelines for this purpose. Please continue building out any guidelines there.

m52go commented 4 years ago

This was also completed in June. https://bisq.wiki/Wiki_style_guidelines

Notable additions in June:

@wiz would you mind closing this issue?