-
Notifications
You must be signed in to change notification settings - Fork 307
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 a FAQ document #741
Labels
DOC
Pertains inclusively to the Documentation operations.
enhancement
Something we do have implemented already but needs improvement upon to the best of knowledge.
Comments
Martii
added
DOC
Pertains inclusively to the Documentation operations.
enhancement
Something we do have implemented already but needs improvement upon to the best of knowledge.
labels
Sep 30, 2015
Martii
pushed a commit
to Martii/OpenUserJS.org
that referenced
this issue
Nov 23, 2015
* More might be added at a future date but these are the most common so far. **NOTES** * One Url is intentionally broken since SEO could trigger a counter increment but the text on the link is what is intended. * In order to accommodate the examples mixed markup and markdown is used in this document... this should be the only exception but the doc still favors markdown Closes OpenUserJS#741
Merged
Martii
pushed a commit
to Martii/OpenUserJS.org
that referenced
this issue
Nov 23, 2015
* Don't header the answers * Add linkage on main about page to the FAQ
Martii
pushed a commit
to Martii/OpenUserJS.org
that referenced
this issue
Nov 23, 2015
* Speaking of the syntax highlight issue mentioned in this DOC... add `md` to it so it doesn't make `to`, `is`, and `my` bolded Post fix for OpenUserJS#741
Martii
added a commit
to Martii/OpenUserJS.org
that referenced
this issue
Dec 6, 2017
* Clean up some of the existing ones Post OpenUserJS#741
Merged
Martii
added a commit
that referenced
this issue
Dec 6, 2017
* Clean up some of the existing ones Post #741 Auto-merge
Closed
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Labels
DOC
Pertains inclusively to the Documentation operations.
enhancement
Something we do have implemented already but needs improvement upon to the best of knowledge.
Since inception there have been some repeat questions (some more silent than others) being asked about the site.
Create a simple FAQ with Q and A in the documents section of /about/... to answer some of the most common ones.
For example (roughly worded and formatted here for GH):
Q: With markdown why does my quoted text merge with my response?
A: Place two line breaks in between your quote and reply like this:
which renders as:
This is my reply
... instead of:
Q: How do I ensure the correct syntax highlighting of my code snippets?
A: Use markdown like these:
Example 1:
which renders as:
Example 2:
which renders as:
... instead of:
The smaller the code snippet the more likely it will automatically pick the wrong highlighting with code fences, or worse no highlighting... so it is best to recommend to site users to coerce the snippet to the correct type.
Refs:
and yes I am probably going to force word-wrap on pre tags soon in discussionsComplete)The text was updated successfully, but these errors were encountered: