New help pages #357
Closed
New help pages #357
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
Chrome will jump too far down if the anchor is after the title text, moving the title out of the viewport.
We currently don't have styles for a <ul> nested within a <dl>, so the spacing is off and it doesn't look right. Instead of introducing a new custom list style for the help index, I try to use the existing grouped_list for this. The downside of this approach is that the help menu doesn't look like one single nested list, but like several lists. For the content that is there at the moment this works well, though, in my opinion.
We might not want to keep this commit because people might not know how to write proper typographic quotes and a mix of straight and real quotes would be worse. However, typographic quotes do look better and also say “professional” in a subtle way that most people will not be able to put their finger on but still notice. An alternative approach could be to enable a smart quote filter for the Markdown documents.
|
Looks fantastic, thank you! As you say, I think we're likely to end up with a mix of straight and proper quotes if we pass them through as-is, so I think I'd rather not. I would like to investigate a smart quote filter though; would you like to take a look at that or should I? |
|
I've merged your first two commits manually so I'll close this for now; we can deal with smart quotes separately. |
|
Thanks for opening up a separate issue on the smart quotes problem, that makes total sense. If no one before me tackles it, I will give it a try, but don't expect it anytime soon 😬 |
|
Of course 👍 |
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.
@hdgarrood I reviewed your commit 92463dd and like it a lot. The explanations on searching are clear to me (still a beginner) and the split into user and author help pages is a good idea to provide help for the context that it is needed in.
I added three small commits that all contain a small description in their respective commit message.
I want to point out that number 3 could be controversial as described in its commit message and you might not want to merge that one (although it would look better).
As for number 2: this is a suggestion of how to use the existing styles better (see screenshot), but if you would want to have a single list that looks more like an index, we'd have to introduce that style (because the spacing in the way you used it before wasn't working so well, I think). To me, number 2 is acceptable and would maybe or maybe not have to be revisited once more topics are added. (In which case you would need to help me with developing the styles in purescript/purescript and then integrate them into purescript/pursuit, I didn't see an easy way right away).