Update documentation to include new implementation #792
Conversation
Initial edits.
|
@mossroy I've attended to your comments, have made some other tweaks, and I've added a major new section on "Contributing". If the "Contributing" section makes this too long for a README, I can put that section in a separate document and link to it. Let me know when you are happy with the text. You can read it properly formatted here. |
|
Actually @gaurav7019 has suggested on Slack that we need a CONTRIBUTING.MD file, so the text I've included in this PR relating to Contributing should be moved to such a file and expanded (to cover things like testing the Extension versions), with a link from here to there. |
|
The contributing section is being moved to #800, and I'll transfer the one change to it from here to there. Please make any revisions on the version there rather than this one (which I'll shortly remove). |
|
Ready for merge when you are. You might want to take look at the new "Limitations" section, which is where I've put the bit about not being able to open ZIM files without picking them, and also a mention of no full-text search. (so we don't keep getting questions asking for it). |
Jaifroid
deleted the
Update-documentation-to-include-new-implementation
branch
This is a follow-on from #771, to provide some cleanup of documentation especially regarding the new implementation.