README, Help info and Changelog—what are their purposes to be? #233
Comments
* Generate a help.json file from help.html (not yet in the repo). * help.json is saved to src/static/ before the build script runs, so it's picked up as part of the repo. * Declare that file in web_accessible_resources and load it from the splash script. * First attempt at generating the HTML from that JSON and inserting it into the splash page. Next steps: * Refactor the JSON in the splash to use the same format as the JSON-to-HTML process (maybe even generate it as part of a build, though most of it is focused on the keyboard stuff, which can be dynamically generated. * Figure out the neatest way to attach custom event listeners after the HTML has been generated (e.g. just use known IDREFs and attach the event listeners after the HTML has been generated). * Include the help HTML & CSS in the extension. Should they go under meta/? How should change notes be incorporated (manually at first I think, as mentioned in #233). Partly addresses #165 and #233.
|
Had though on this for a while, and got quite far with a new web home page and the outline of a help page (Help page first added in df8d0d5). However, the questions above need proper answers...
A friendly and relatively simple page that states/shows what Landmarks does.
As above. Could link to the help page if it's already installed.
The help page (first added in df8d0d5), which includes what's new in this version and keyboard shortcuts. The sections are in details/summary disclosure widgets, so the appropriate ones could be expanded based on if this is an install or upgrade.
As above, though maybe in a slightly different expanded/collapsed configuration.
Maybe a brief intro as to what Landmarks does, but not as great as the main web site. No need to include how to use it, as that's covered in the help for each version. Definitely the information on support, development, and for authors—at least currently that's intended to be the destination of links for "more info for authors/developers" from the Help page.
New headline (pun intended) features can be added to the home web page; how to use them would be added to the Help pages. The README would be updated if this has a bearing on development/standards support (which it sounds like it would). |
|
The initial version of the new web home page was completed in 33ca7f5 (that was the last of four related commits). Things to do:
The general direction of travel has now been established, so will close this. |
The changelog has recently been spun off as a separate thing, which paves the way for release-specific info that's of interest to most users to be included in the release and potentially for automagical creation of the full changelog using automated tools.
However, thought is needed on the following:
The text was updated successfully, but these errors were encountered: