Add external links

CONTRIBUTING.md

@@ -1,14 +1,13 @@
 # Contributing to RCTab
 
-We appreciate your interest in contributing to RCTab. 
+We appreciate your interest in contributing to RCTab.
 
 If you spot a bug, or have a feature request, please raise an issue in the relevant repository. If you would like to contribute code, please ensure you have checked the existing issues and pull requests to ensure your contribution is not already in progress. If you are unsure, please raise an issue to discuss your idea before you start work.
 
 ```{warning}
 Please do not report security vulnerabilities in public issues. Please raise a private security issue in the relevant repository.
 ```
 
-All contributions are made via pull requests to the repository containing the code you wish to contribute to. For example, if you have a bug fix for the CLI, you would submit a pull request to the [rctab-cli repository](https://github.com/alan-turing-institute/rctab-cli). If you have a change for the API you would submit a pull request to the [rctab-api repository](https://github.com/alan-turing-institute/rctab-cli). In you have a change for the a function app, you would submit a pull request to the [rctab-function-apps repository](https://github.com/alan-turing-institute/rctab-functions). Please make a fork of the appropriate repository and submit your pull request from your fork.
-
-All documentation is stored in the repository where the code it documents is stored. The main RCTab repo brings these files together for the documentation website. Please ensure you thoroughly document your changes in the repo where you have edited the code, but leave the task of updating the documentation website to the maintainers.
+All contributions are made via pull requests to the repository containing the code you wish to contribute to. For example, if you have a bug fix for the CLI, you would submit a pull request to the [rctab-cli repository](https://github.com/alan-turing-institute/rctab-cli). If you have a change for the API you would submit a pull request to the [rctab-api repository](https://github.com/alan-turing-institute/rctab-cli). If you have a change for the a function app, you would submit a pull request to the [rctab-function-apps repository](https://github.com/alan-turing-institute/rctab-functions). If you have a change for the documentation, please sumit a pull request to this repository. Please make a fork of the appropriate repository and submit your pull request from your fork.
 
+Please make sure that you have added tests and documentation for any fixes or new features.

docs/index.rst

@@ -4,8 +4,42 @@ Welcome to RCTab
 .. warning:
    🚧 This documentation is under construction 🚧
 
+RCTab is an open-source subscription management and reporting system for Microsoft Azure.
+It gives users visibility of their subscriptions' spending via the web front-end and allows administrators to set hard budget limits using the CLI.
+With RCTab, you can give users more control over resource creation without spending extra time monitoring costs.
 
-An Azure subscription management, reporting, and usage monitoring system. Created by The Institute.
+Features
+++++++++
+
+* A CLI for administrative tasks.
+* A web front-end for admins and end-users.
+* Automated deployment with Pulumi.
+* Single Sign On with Azure Active Directory.
+* Email notifications.
+
+Components
+++++++++++
+
+The complete system comprises:
+
+* A web server `web server <https://github.com/alan-turing-institute/rctab-api>`_.
+* The `CLI <https://github.com/alan-turing-institute/rctab-cli>`_, which allows command line interaction with the web server.
+* Three `Function Apps <https://github.com/alan-turing-institute/rctab-functions>`_, which run background jobs to interact with Azure:
+
+  * Usage: Gets usage data from Azure and posts to this API.
+  * Status: Gets information about subscriptions from Azure, such as state and RBAC and posts to this API.
+  * Controller: Gets list of subscriptions and their desired state from the API and then enables or disables subscriptions on Azure.
+* An `authentication library <https://github.com/alan-turing-institute/fastapimsal>`_, which handles authentication using Microsoft's MSAL library for FastAPI.
+
+Contribute
+++++++++++
+
+We welcome contributions in the form of issues and pull requests. Please see our :doc:`contributing guidelines <content/contributing>` and :doc:`code of conduct <content/code_of_conduct>`.
+
+Contact Us
+++++++++++
+
+If you need to get in touch with us, please open an issue on our `GitHub repo <https://github.com/alan-turing-institute/rctab>`_.
 
 .. toctree::
    :maxdepth: 2
@@ -14,3 +48,18 @@ An Azure subscription management, reporting, and usage monitoring system. Create
    :hidden:
 
    content/*
+
+.. toctree::
+   :maxdepth: 2
+   :caption: External Links
+   :glob:
+   :hidden:
+
+   API docs <https://rctab-api.readthedocs.io/en/latest/>
+   API repository <https://github.com/alan-turing-institute/rctab-api>
+   Functions docs <https://rctab-functions.readthedocs.io/en/latest/>
+   Functions repository <https://github.com/alan-turing-institute/rctab-functions>
+   CLI docs <https://rctab-cli.readthedocs.io/en/latest/>
+   CLI repository <https://github.com/alan-turing-institute/rctab-cli>
+   Infrastructure docs <https://rctab-infrastructure.readthedocs.io/en/latest/>
+   Infrastructure repository <https://github.com/alan-turing-institute/rctab-infrastructure>