Skip to content
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

Create style guidelines article #9

Closed
cbeams opened this issue Feb 25, 2020 · 2 comments
Closed

Create style guidelines article #9

cbeams opened this issue Feb 25, 2020 · 2 comments
Assignees

Comments

@cbeams
Copy link
Member

cbeams commented Feb 25, 2020

From a conversation between @m52go and @cbeams at bisq-network/projects#6 (comment):

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 cbeams created this issue from a note in Roll out the Bisq Wiki (To do) Feb 25, 2020
@cbeams
Copy link
Member Author

cbeams commented Feb 26, 2020

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

@m52go
Copy link

m52go commented Jul 22, 2020

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

Notable additions in June:

@wiz would you mind closing this issue?

@m52go m52go closed this as completed Jul 23, 2020
Roll out the Bisq Wiki automation moved this from To do to Done Jul 23, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

No branches or pull requests

2 participants