Skip to content

Commit 4c3c68c

Browse files
Fix links to Install and Doc contribute guides
Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>
1 parent 8fc64be commit 4c3c68c

2 files changed

Lines changed: 10 additions & 6 deletions

File tree

CONTRIBUTING.rst

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,7 @@ For other questions, discussions, and chats, we have:
5656

5757
- a mailing list at `sourceforge <https://lists.sourceforge.net/lists/listinfo/aboutcode-discuss>`_
5858

59+
- a Gitter channel to discuss Documentation at https://gitter.im/aboutcode-org/gsod-season-of-docs
5960

6061
Bug reports
6162
===========
@@ -77,10 +78,13 @@ When `reporting a bug`__ please include:
7778
Documentation improvements
7879
==========================
7980

80-
Documentation can come in the form of wiki pages, docstrings, blog posts,
81-
articles, etc. Even a minor typo fix is welcomed.
82-
See also extra documentation on the `Wiki <https://github.com/nexB/scancode-toolkit/wiki>`_.
81+
If something is missing in the documentation or if you found some part confusing,
82+
please file an issue with your suggestions for improvement. Use the “Documentation Improvement”
83+
template. Your help and contributions makes ScanCode docs better, we love hearing from you!
8384

85+
The ScanCode documentation is hosted at `scancode-toolkit.readthedocs.io <https://scancode-toolkit.readthedocs.io/en/latest/>`_.
86+
87+
If you want to contribute to Scancode Dcoumentation, you'll find `this guide here <https://scancode-toolkit.readthedocs.io/en/latest/contribute/contrib_doc.html>`_ helpful.
8488

8589
Development
8690
===========

README.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -93,9 +93,9 @@ refers to installing the required Python interpreter (Python 3.6 is recommended)
9393

9494
There are 3 main ways you can `install ScanCode <https://scancode-toolkit.readthedocs.io/en/latest/getting-started/install.html>`_.
9595

96-
- `Installation as an Application: Downloading Releases <https://scancode-toolkit.readthedocs.io/en/latest/getting-started/install.html#download-and-configure-latest-release>`_ *(Recommended)*
97-
- `Installation as a library: via pip <https://scancode-toolkit.readthedocs.io/en/latest/getting-started/install.html#installation-by-pip>`_
98-
- `Installation from Source Code: Git Clone <https://scancode-toolkit.readthedocs.io/en/latest/getting-started/install.html#build-from-source>`_
96+
- `Installation as an Application: Downloading Releases <https://scancode-toolkit.readthedocs.io/en/latest/getting-started/install.html#installation-as-an-application-downloading-releases>`_ *(Recommended)*
97+
- `Installation from Source Code: Git Clone <https://scancode-toolkit.readthedocs.io/en/latest/getting-started/install.html#installation-from-source-code-git-clone>`_
98+
- `Installation as a library: via pip <https://scancode-toolkit.readthedocs.io/en/latest/getting-started/install.html#pip-install>`_
9999

100100
Quick Start
101101
===========

0 commit comments

Comments
 (0)