Documentation Inconsistencies/Improvements Tracker

[AyanSinhaMahapatra]

This Issue is to Track Documentation Inconsistencies in One Place.

---

1. Issues Already Present

Bugs/Other Inconsistencies

• Docs in Wiki Outdated [Add Disclaimer and Links to ReadTheDocs]
• Update Docs in Pypi Page
• Update README (mention pip install and Python 3 support)
• Check that all Links to Documentation in Various places point to ReadTheDocs (and not the Wikis)
• Take the information in CONTRIBUTING.rst into the Contribute Section of Docs.
• Take information from README.rst files in the source code folders , or link to them, in the docs.

---

2. CLI Options Marked as [ToDo] (For Improvement)

• --license-score [Basic Options] scancode-toolkit doc on license scoring aboutcode#28
• --generated [Basic Options]
• --reindex-licenses [Core Options]
• --license-clarity-score [Post Scan Options]

---

3. Issues after an Upgrade/Solved Issue

Docs That Will be inconsistent after a new feature (which is currently WIP/requested)

• Moving out samples folder. Improve examples  #1031 Remove built-in samples/ #1286
• Including Python 3 in Installer Create installer of scancode-toolkit including Python 3 #1703
• Update Plugins Doc related to Put release archives on a diet #1815
• Update Installation info to include Python 3.7 and 3.8 Upgrade scancode to Python 3.7 and 3.8 #1819
• Update Issue Templates with Links Add Final Improvements/Changes before Migrating aboutcode#33 Add New Issue and Pull Request Templates #1827
• Remove warnings from docs after these are solved - Error in filter-clues Plugin #1758 Error in summary-by-facet Plugin #1759
• Update all docs with link to the getting started page Add Final Improvements/Changes before Migrating aboutcode#33

[AyanSinhaMahapatra]

@pombredanne Can we have a "long-running" label for this type of issue? Another example is #1146 . The type of issues that will host "first-timers-only" that you suggested (like publiclab/plots2#6206) will also fall under this category. It's better that we use these more to keep track of one type of change (long-running and unlike projects or milestones ), or newcomer materials.

[pombredanne]

Can we have a "long-running" label for this type of issue?

Thank you: I added this.

[AyanSinhaMahapatra]

This is now updated and has issues from aboutcode-org/aboutcode#32 here. As that issue is being closed.