diff --git a/server/documentation/api/index.rst b/server/documentation/api/index.rst index 7d84fc9..2a1a1a1 100644 --- a/server/documentation/api/index.rst +++ b/server/documentation/api/index.rst @@ -7,3 +7,5 @@ Corvus API documentation authentication user + +API documentation for the modules \ No newline at end of file diff --git a/server/documentation/introduction.rst b/server/documentation/introduction.rst index cc56aa3..178efad 100644 --- a/server/documentation/introduction.rst +++ b/server/documentation/introduction.rst @@ -1,4 +1,14 @@ Introduction To Corvus ======================== -TODO +Corvus is the scaffolding for python web services. Among the things it offers are the following: + +* Management CLI for working with users +* Prebuilt auth framework with roles and tokens +* Hierarchical role models +* Stong testing foundation +* Strong code formatting testing foundation +* PipEnv scaffold for ensuring reproducable builds +* Prebuilt docker environments for runtime +* Pythonenv integration +* Lightweight Flask backend