summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--modules/hosting/example/index.php21
1 files changed, 21 insertions, 0 deletions
diff --git a/modules/hosting/example/index.php b/modules/hosting/example/index.php
new file mode 100644
index 0000000..f1e7955
--- /dev/null
+++ b/modules/hosting/example/index.php
@@ -0,0 +1,21 @@
+<?php
+
+/** @mainpage Aegir API documentation
+ * Welcome to Aegir's API and internals documentation. This site aims
+ * to document all aspects of the code, internal and external API to
+ * facilitate maintenance of the code, but also provide an explicit
+ * and well-defined API for developpers to write contrib modules on
+ * top of.
+ *
+ * This site is arranged in three main sections:
+ * - @link /api/Drush The Drush 4 documentation @endlink
+ * - @link /api/Hostmaster The frontend documentation @endlink
+ * - @link /api/Provision The backend documentation @endlink
+ *
+ * Various topics are accessible from there, but you may want to start
+ * by looking at those pages if you are writing a contrib module:
+ *
+ * - @link hosting_example.module The hosting_example module @endlink
+ * - @link backend-frontend-IPC The backend/frontend communication system @endlink
+ * - @link hostingserviceapi The frontend Service API @endlink
+ */ \ No newline at end of file