Merge branch 'master' into gsoc24-swastkk

aboutcode-org · Aug 23, 2024 · d9e79e2 · d9e79e2
2 parents cfe1091 + c158429
commit d9e79e2
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 339 deletions.
diff --git a/docs/source/contributing.rst b/docs/source/contributing.rst
@@ -2,21 +2,19 @@
 Contributing to AboutCode
 #########################
 
-The AboutCode organization welcomes you and your interest in contributing to our
-organization. We are always looking for enthusiatic contributors and we are willing to
-lend a helping hand if you have any questions or comments. That being said, here a few
-resources to help you get started.
+We welcome you and your interest in contributing to open source software! AboutCode is always looking for enthusiatic contributors and we are happy to help with any questions or comments. Here a few resources to get started:
 
 1) Take a look through our public repos here: https://github.com/aboutcode-org/
     * Find one you are interested in and check out its open **Issues**
 2) If you have specific questions browse through our documentation here: https://aboutcode.readthedocs.io/en/latest/
-    * Depending on the project, there may be a seperate ReadTheDocs website
-    * If you did not find what you were looking for or you still have questions,
-      open an issue on the relevant repository, or ask directly via Gitter
+    * Depending on the project, there may be a separate ReadTheDocs website
+    * Not finding what you were looking for or still have questions? Open an issue on the relevant repository or ask directly via Gitter or Slack
 
-You can always interact with the AboutCode organization and our extended community on Gitter_
+You can always interact with the AboutCode community on Gitter_ and Slack_.
 
 .. _Gitter: https://gitter.im/aboutcode-org/discuss
+.. _Slack: https://join.slack.com/t/aboutcode-org/shared_invite/zt-2hjzc448i-SZULSuI0~h6YNSUnBWlAqA
+
 
 ************************
 Contribution Guidelines:

diff --git a/docs/source/contributing/contrib_doc.rst b/docs/source/contributing/contrib_doc.rst
@@ -3,6 +3,23 @@
 Contributing to the Documentation
 =================================
 
+Document Software Setup
+-----------------------
+
+AboutCode documentation is built using Sphinx.
+See http://www.sphinx-doc.org/en/master/index.html
+
+AboutCode documentation is distributed using "Read the Docs".
+See https://readthedocs.org/
+
+Individual document files are in reStructuredText format.
+See http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html
+
+You create, build, and preview AboutCode documentation on your local machine.
+
+You commit your updates to the AboutCode repository on GitHub, which triggers
+an automatic rebuild of https://aboutcode.readthedocs.io/en/latest/index.html
+
 .. _contrib_doc_setup_local:
 
 Setup Local Build

diff --git a/docs/source/doc_guidelines.rst b/docs/source/doc_guidelines.rst
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -35,7 +35,6 @@ Contributing and GSoC/GSoD
    contributing
    archive/gsoc-toc
    archive/gsod-toc
-   doc_guidelines
 
 ******
 Others