search

rthaut / deviantART-Filter

A browser extension that allows you to filter DeviantArt by user, keyword, and/or category.
https://rthaut.github.io/deviantART-Filter/
GNU General Public License v3.0
31 stars 1 forks source link

Project Page #71

Closed rthaut closed 4 years ago

rthaut commented 5 years ago

Much of the documentation in the READMEs (both the main README and the browser-specific ones in the /docs directory) could/should be moved to a GitHub Project Page.

This would both reduce the size/complexity of the READMEs and negate the need for multiple README files.

Additionally, the verb and verb-generate-readme tools should probably be removed, as they are the source of all current vulnerabilities (as reported by npm audit).

The biggest (potential) loss for this documentation overhaul would likely be the plain-text / minimal-HTML versions of the documentation that are generated automatically for Chrome, Firefox, and DeviantArt, the current processes for which were created for #41.

However, with the creation of a Project Page, the descriptions for those sites could be vastly simplified to provide an overview and direct users to the Project Page for all additional information. That would in essence consolidate all documentation updates to one location (the Project Page).

rthaut commented 4 years ago

This is mostly implemented now, although the descriptions on the Chrome and Firefox extensions stores/hubs could be further refined and link(s) to the new Project Page could be added, so I am not closing this issue just yet.

Also, the change log is still maintained in the repository; it might make more sense to move that to the Project Page, since the goal was to consolidate documentation. Alternatively, maybe a link to the CHANGELOG.md file simply needs to be added to the Project Page...