Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.
Sign upConsider clearly labeling documentation intended for developers #2498
Comments
andrewdavidwong
self-assigned this
Dec 8, 2016
andrewdavidwong
added
C: doc
enhancement
labels
Dec 8, 2016
andrewdavidwong
added this to the
Documentation/website milestone
Dec 8, 2016
added a commit
to QubesOS/qubesos.github.io
that referenced
this issue
Dec 8, 2016
andrewdavidwong
closed this
in
QubesOS/qubesos.github.io@0b30877
Dec 8, 2016
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
jpouellet commentedDec 8, 2016
•
edited
Edited 1 time
-
jpouellet
edited Dec 8, 2016 (most recent)
On Mon, Dec 5, 2016 at 3:40 AM, Zbigniew Łukasiak wrote:
I'm in no way qualified to give UX advice, but perhaps docs intended for devs should be clearly signaled as such in the on-line html-rendered doc pages? It seems to me some line of red text at the top and bottom of the content saying so should suffice.
The goal would be to avoid giving the impression to non-technical prospective Qubes users that understanding such things are required for normal use of the system, and perhaps provide links to end-user-targeted docs they may be looking for instead if appropriate?