feat: Enhanced help documentation, bundled with the extension #237
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
* Use the method that Tridactyl employs to load the content script directly in an extension page, so that it can be used there. This is much simpler than what I was trying before! * Improve the clarity (for end-users) of the "no connection" error message.
The site no longer gets built by Jekyll
Needs re-organising a bit, but that will come soon...
* Add a link to the bundled help page from the web home page. This uses the same name "splash" for the connection to the background page. * Fold the splash script into the help page (and rename accordingly). * Remove redundant splash CSS (fold relevant stuff into help.css). * Update build script to reflect "_splash.js" is now "_help.js". * Remove default keyboard shortcuts help content from the help page.
Not actually sure when, but it seems like it would take some time to find out, and Opera is evergreen, so requiring the latest version does not seem /too/ draconian.
This makes them work in the same way most web pages work navigation-wise.
* Make the keyboard shortcuts table look pretty and more legible. * Use a two-column layout - did not realise that CSS columns and fragmentation existed! :-) * Ensure the button inherits the body text font size.
* Add version reporting to help page. * Fix font size on Chrome-like browsers.
This matches the navigation semantics updated in 6ff16a4
* Add more links to directly open keyboard shortcuts and settings pages from the help page (this has introduced some duplicated HTML, but seems OK for now; will probably clean up later). * Use greens (based on the web home page gradient green, and a lighter version from <http://www.0to255.com/159957>, to style of the note in the sidebar to make it less errory-looking. * Use rounded borders on the note in the sidebar. * Re-arrange sections in the help page.
This can be used for reverting to defaults.
Show/hide sections in the help page depending on if this is a new install or an update.
These are now covered by the help page.
* Have (almost) all details sections open by default, regardless of whether it's an install or an upgrade (countermanding some of the ideas from 9bce417). * Only open the "What's New" section if it's an update. * Only open the "Sidebar" section on Firefox and Opera. * Improve margins for the details sections (and footer, to match). * Add a border at the bottom of each details section. * Ensure all list item text is within a paragraph. * Use sentence case for all headings. * Clarify the headings.
* Add a "call to action" section for when the extension is installed or updated, to let the user know if anything needs doing (could expand this in future to alerting the user to any unused keyboard shortcuts even when they browse normally to the help page). * Ensure that links to sections cause those sections to be open when the link is followed. * Tidy up the help JS code.
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.
Add a new, HTML help page that explains how to use the extension, including reflecting keyboard shortcuts and providing links to go directly to the settings, for convenience.
This was created by moving some content from the README and the techniques from the original “splash” content script. It also directly imports the main Landmarks content script so that the extension can itself be used to navigate this page. Refer to #165 for the details.
Partly addresses #165 (provides the foundation for managing the keyboard shortcuts when another one is added).