Split FAQs, add list of terminal emulators, add project_urls #689
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Also update link at top of README to allow functioning on PyPI, and adjust the gitlint rule to allow sections to include 'FAQ'.
zulipbot
added
size: XL
neiljp
force-pushed
the
2020-06-14-FAQ-terminals
branch
from
54b2113
to
b68f591
Compare
neiljp
added
PR needs review
preetmishra
reviewed
Jun 15, 2020
There was a problem hiding this comment.
@neiljp Thanks for pushing these changes. The changes and the commit messages look. The links on pypi work as expected as well. 👍
| * version 0.3.1 and earlier: the error is shown on the terminal; | ||
| * versions 0.3.2+: the error is present/appended to the file `zulip-terminal-tracebacks.log`. | ||
|
|
||
| ## Something looks wrong! Where's this feature? There's a bug! |
There was a problem hiding this comment.
[minor] '##' looks a bit noisy in FAQ.md, particularly with underlines, because the content does not have enough whitespace. Would '###' be better?
There was a problem hiding this comment.
I used ## since that's the semantic level in the document, a little like <h1> and <h2> - but there's no CSS to style it within github that I'm aware of :)
neiljp
force-pushed
the
2020-06-14-FAQ-terminals
branch
from
b68f591
to
8066e86
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The changes should be self-explanatory, but basically this shows the information determined to date via #662 into a new FAQ file containing the previous 'troubleshooting' text.
This also adds
project_urlsmetadata tosetup.py, which adds them in the sidebar. A preview of this can be seen at https://test.pypi.org/project/zulip-term/0.5.2a2/ (see project links in the side bar)