aboutcode-org / aboutcode-org/scancode-toolkit

Documentation Inconsistencies/Improvements Tracker

未關閉
#1,813 4 則留言 1 個 reaction 已指派 0 人 在 GitHub 檢視
documentation long running new feature Priority: medium
主要語言
Python
星號
2.6k
分支
791
平均合併
1 天 12 小時
30 天內合併 PR
5

描述

## **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](https://github.com/nexB/scancode-toolkit/blob/develop/CONTRIBUTING.rst) into the Contribute Section of [Docs](http://scancode-toolkit.readthedocs.io/).
- [ ] 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] nexB/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. #1031 #1286
- [ ] Including Python 3 in Installer #1703
- [ ] Update Plugins Doc related to #1815
- [ ] Update Installation info to include Python 3.7 and 3.8 #1819
- [ ] Update Issue Templates with Links https://github.com/nexB/aboutcode/pull/33 #1827
- [ ] Remove warnings from docs after these are solved - #1758 #1759
- [ ] Update all docs with link to the getting started page https://github.com/nexB/aboutcode/pull/33

貢獻指南

開啟貢獻指南

評估

這個 Issue 還沒有評估資料。

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。