Skip to content
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

Migrate all wiki information to user.js/README, doc improvements #225

Merged
merged 18 commits into from
Mar 1, 2017
Merged

Migrate all wiki information to user.js/README, doc improvements #225

merged 18 commits into from
Mar 1, 2017

Conversation

nodiscc
Copy link
Contributor

@nodiscc nodiscc commented Mar 1, 2017

Ref #220

Each separate commit should be self-explanatory.

The latest README version from this branch is viewable here: https://github.com/nodiscc/user.js/blob/wiki-migration/README.md

…E, improve README:

* contributing: use 80-char line width, add RSS feed recommendation
* use #-style markdown headers
* references section: sort and update/improve links, add rss feeds, remove duplicate links

Part of #220
unshorten links
clarify some descriptions
add mozilla privacy principles to references
Part of #220
…to user.js:

rename section to HTML5/DOM APIs
improve descriptions
Part of #220
improve/reorder caching section:
improve descriptions, some reordering/prefs grouping
Part of #220
* migrate wiki page Firefox-exploits-&-vulnerabilities to user.js/README
* contributing: add RSS feed recommendation
* change 1st level title to user.js
* reorder, reword short description
* (temporarily) remove obsolete Table of Contents
* reword installation section headers
* split long lines to 80-char width
* further hardening: add reminder to update plugins
* migrate wiki FAQ page to README
* move beef link to references, improve
Part of #220
references: disambiguate headers (explicit anchor links)
@nodiscc
Copy link
Contributor Author

nodiscc commented Mar 1, 2017

The last 5 commits add a few fixes and reordering.

The first-level table of contents is now

## Download
## Installation
## What does it do?
## Further hardening
## Known problems
## CAs
## FAQ
## Contributing
## Online tests
## References

fix headers hierarchy for upcoming table of contents
@pyllyukko
Copy link
Owner

Looks good! Should we move the FAQ part into a separate file?


# How to use the user.js file

TODO insert toc
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should either re-add it, or remove the TODO from here and reopen #126 or create new issue about the TOC.

@pyllyukko pyllyukko merged commit f91d069 into pyllyukko:master Mar 1, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants