Merge pull request #1386 from dedis/work-fe1-kschneiter-update-doc

Update documentation of fe1

fe1-web/docs/README.md

@@ -47,13 +47,20 @@ Here's the annotated directory tree:
 │
 │   ├── components               # library of simple, reusable UI component
 │   │
+│   ├── contexts                 # feature context type definition
+│   │
+│   ├── functions                # module containing functions that are useful in the whole application
+│   │
+│   ├── hooks                    # contains utility react hooks
+│   │
 │   ├── keypair                  # module dealing with the storage of a global, unique keypair
 │   │
 │   ├── navigation               # module dealing with the top-level React navigation
 │   │
 │   ├── network                  # module to network with the backend
 │   │   ├── ingestion              # implementation and configuration of the processing of incoming messages
 │   │   ├── jsonrpc                # network & protocol objects
+│   │   ├── strategies             # sending strategies when there are multiple servers
 │   │   └── validation             # protocol validation utilities
 │   │
 │   ├── objects                  # module containing the core business objects
@@ -62,14 +69,15 @@ Here's the annotated directory tree:
 │   │
 │   ├── redux                    # module dealing with the global configuration of the application state (Redux-based)
 │   │
-│   └── styles                   # stylesheets
+│   ├── styles                   # stylesheets
+│   │
+│   └── types                    # some generic types
 │
 ├── features                 # independent features in the system
 │
-│   ├── connect                  # feature dealing with LAO/server connection
-│   │
 │   ├── lao                      # feature dealing with the notion of a LAO, showing the typical feature structure
 │   │   ├── components             # feature components
+│   │   ├── errors                 # feature errors definition
 │   │   ├── functions              # feature functions
 │   │   ├── hooks                  # feature hooks
 │   │   ├── interface              # defines the dependencies of the feature and the interface it exposes
@@ -80,6 +88,8 @@ Here's the annotated directory tree:
 │   │   ├── screens                # UI screens of the feature
 │   │   └── store                  # static access to the feature's reducer store (DEPRECATED)
 │   │
+│   ├── digital-cash             # feature dealing with digital cash
+│   │
 │   ├── events                   # feature dealing with events happening in a LAO
 │   │
 │   ├── evoting                  # feature dealing with E-Voting and Elections
@@ -88,6 +98,8 @@ Here's the annotated directory tree:
 │   │
 │   ├── meeting                  # feature dealing with meetings, a type of event
 │   │
+│   ├── notification             # feature dealing with notifications
+│   │
 │   ├── rollCall                 # feature dealing with roll calls, a type of event
 │   │
 │   ├── social                   # feature dealing with social media functionality

fe1-web/src/features/social/README.md

@@ -5,6 +5,8 @@ participants to "chirp", react to chirps and follow each other.
 
 ## Dependencies
 
-**Note**: This feature has not been separated from the other features yet and
-thus the exact dependencies are a bit unclear. Running `npm run depcruise`
-suggests that it depends on the `rollCall`, `lao` and `wallet` features.
+- Basic LAO functionality provided by the `lao` feature
+- LAO Events support provided by the `events` feature
+- Wallet functions to generate PoP tokens
+
+See `interface/Configuration.ts` for more details.