mirror of
https://github.com/debauchee/barrier.git
synced 2026-05-15 22:01:23 -06:00
[GH-ISSUE #95] Decide on layout for documentation #70
Labels
No labels
HiDPI
bounty
bsd/freebsd
bsd/openbsd
bug
bug
build-infra
cantfix
critical
doc
duplicate
enhancement
fix-available
from git
from release
good first issue
help wanted
installer/package
invalid
linux
macOS
meta
needs testing
pull-request
query
question
regression
regression
v2.4.0
windows
wontfix
work-in-progress
No milestone
No project
No assignees
1 participant
Notifications
Due date
No due date set.
Dependencies
No dependencies set.
Reference: github-starred/barrier#70
Loading…
Add table
Add a link
Reference in a new issue
No description provided.
Delete branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Originally created by @AdrianKoshka on GitHub (Jul 14, 2018).
Original GitHub issue: https://github.com/debauchee/barrier/issues/95
With #88 closed, I thought we should start brain-storming on how the documentation site should be laid out. As a person who writes documentation, my job isn't only to write documents, but to be sure the UI/UX experience of reading them is pleasant and makes sense.
@AdrianKoshka commented on GitHub (Jul 14, 2018):
Later I'll probably post some rough concepts I have.
@AdrianKoshka commented on GitHub (Jul 17, 2018):
Here's some screenshots on what it should look like, I took them via Google Chromes' device mode:
1080p, desktop
720p, desktop
Full page
1080p, desktop, Sample documentation page:
720p, desktop, Sample documentation page:
Full page, Sample documentation page:
Pixel 2, Introductory page
Pixel 2, Side Bar
iPhone 6/7/8, Introductory page
iPhone 6/7/8 Side Bar
@W4RH4WK commented on GitHub (Jul 18, 2018):
Looks good.
@walker0643 commented on GitHub (Sep 8, 2018):
I like it, too. Well done, @AdrianKoshka :)
@dayne commented on GitHub (Sep 27, 2018):
@AdrianKoshka I'm interested in potentially contributing to the docs. Can you describe your plan of attack for managing, collaborating, and rendering the documentation?
Looks like you are aiming for a rendered website for the docs. Potentially a static site generator tool like jekyll, hugo or some other system? Would you be making a new repo, like barrier-docs, or using the existing code repo to manage the docs?
My brain has been in this region last few weeks as I've been making a few pushes where I've been using Github Pages for organizing and presenting documentation that is embedded within the code repo. I would be interested in helping get documentation effort up and running as a collaborative project if that is of interest.
Timing is good too because I am about to setup a new Linux + Mac workstation environment for myself and will be capturing all my setup notes/commands as I go -- would be nice to funnel that towards improving documentation for others.
@AdrianKoshka commented on GitHub (Sep 28, 2018):
I can't remember what static generator I've been using (Probably hugo though). I'll have to look at my work and I'll probably put it in another branch or repo.
@AdrianKoshka commented on GitHub (Sep 28, 2018):
My progress is currently in my fork, on the
pages-develbranch, it seems I've usedmkdocs. https://github.com/adriankoshka/barrier/tree/pages-devel@AdrianKoshka commented on GitHub (Dec 17, 2018):
Decided not to do end-user documentation on it's on github.io site. We've decided to commit to the wiki.