Merge pull request #299 from AKVorrat/docs-entrypoint

Added links to all relevant pages of the documentation

README.md

@@ -62,19 +62,55 @@ DearMEP is a white-label solution that can be tailored for any EU legislative is
 
 To add DearMEP to your campaign page using an existing instance, simply copy a few lines of HTML. First, ask the instance administrator to add your campaign site’s URL to the allowed origins on the DearMEP server. Then, paste the HTML snippet into your page.
 
-More details can be found [here](./client/README.md).
+More details can be found in the [client README](./client/README.md).
 
 ### Setting Up a New Instance
 
 Setting up a new instance requires additional steps, including configuring the server and preparing a list of MEPs. This repository includes example configurations and scripts to simplify the process. Additionally, you’ll need an account with [46elks](https://46elks.com/), which serves as the calling provider.
 
-Further setup instructions are available [here](./server/README.md).
+Further setup instructions are available in the [server README](./server/README.md).
+
+---
+
+## 📚 Documentation
+
+Get started quickly and explore all aspects of this project with our detailed documentation:
+
+### Core Documentation
+
+- [Server README](./server/README.md): Discover how to set up the server, maintain the database, and manage a development environment.
+- [Client README](./client/README.md): Learn how to embed the client application, how to customize it, as well as build and development steps.
+
+### Additional Resources
+
+- [Glossary](./doc/glossary.md): Key terms and concepts used throughout the project.
+- [Data Protection & Privacy](./doc/data-protection.md): Understand how we handle sensitive data and protect the privacy of our users.
+- [Security](./doc/security.md): Measures we take to ensure the security of our software.
+- [Converting Data](./doc/data-conversion.md): Steps to convert European Parliament data for use with DearMEP.
+- [Theming](./doc/theming.md): Tailor the client design to match your campaign’s homepage design.
+- [DearMEP Prometheus Metrics](./doc/metrics.md): Metrics that let you know what is going on with a production instance.
+- [Selecting Destinations](./doc/selecting-destinations.md): How DearMEP suggests who to call.
+- [Interactive Voice Response (IVR)](./doc/ivr.md): Describes the structure of the voice menu that our users interact with over the phone.
+- [Scheduler](./doc/scheduler.md): The internals of how we are scheduling calls.
+- [API Documentation](https://redocly.github.io/redoc/?url=https://akvorrat.github.io/dearmep/openapi.json) (OpenAPI ReDoc): Detailed API reference for advanced integrations and custom client implementations.
 
 ---
 
 ## 🛡️ License
 
-This project is licensed under the **AGPL License**. See the [LICENSE](LICENSE) file for details.
+This project is licensed under the **AGPL License**. See the [`LICENSE.md`](LICENSE.md) file for details.
+
+---
+
+## 🤝 Contributing
+
+We appreciate contributions from the community!
+
+Before you get started, please take a moment to review our [contribution guidelines](CONTRIBUTING.md).
+
+Ideally discuss your planned contributions with members of the core team in a GitHub Issue beforehand.
+
+Thank you for helping us make this project better! 🚀
 
 ---
 

client/src/app/common/interceptors/retry.interceptor.ts

@@ -124,7 +124,7 @@ export class RetryInterceptor implements HttpInterceptor {
     console.error(
       `${errorName} encountered. Retrying after ${retryInterval / 1000.0}s (url: ${url}).`
     );
-    return this.reatryAfter(retryInterval);
+    return this.retryAfter(retryInterval);
   }
 
   private getRetryAfter(
@@ -142,7 +142,7 @@ export class RetryInterceptor implements HttpInterceptor {
     return Math.max(retryAfter, minRetryAfter);
   }
 
-  private reatryAfter(timeout: number): Observable<void> {
+  private retryAfter(timeout: number): Observable<void> {
     return of(undefined).pipe(delay(timeout));
   }