diff --git a/docs/docs/README.md b/docs/docs/README.md index c6d717a58e..a3b784afe2 100644 --- a/docs/docs/README.md +++ b/docs/docs/README.md @@ -1,53 +1,10 @@ -talawa-admin / [Modules](modules.md) +# Documentation for Talawa Admin -# Talawa Admin +This is the documentation for the Talawa Admin web application. -💬 Join the community on Slack. The link can be found in the `Talawa` [README.md](https://github.com/PalisadoesFoundation/talawa) file. +The Talawa Admin application is a web application that provides a user interface for the Talawa Foundation's administrative tasks. -![talawa-logo-lite-200x200](https://github.com/PalisadoesFoundation/talawa-admin/assets/16875803/26291ec5-d3c1-4135-8bc7-80885dff613d) +This documentation is split into two main sections: -[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) -[![GitHub stars](https://img.shields.io/github/stars/PalisadoesFoundation/talawa-admin.svg?style=social&label=Star&maxAge=2592000)](https://github.com/PalisadoesFoundation/talawa-admin) -[![GitHub forks](https://img.shields.io/github/forks/PalisadoesFoundation/talawa-admin.svg?style=social&label=Fork&maxAge=2592000)](https://github.com/PalisadoesFoundation/talawa-admin) -[![codecov](https://codecov.io/gh/PalisadoesFoundation/talawa-admin/branch/develop/graph/badge.svg?token=II0R0RREES)](https://codecov.io/gh/PalisadoesFoundation/talawa-admin) - -Talawa is a modular open source project to manage group activities of both non-profit organizations and businesses. - -Core features include: - -1. Membership management -2. Groups management -3. Event registrations -4. Recurring meetings -5. Facilities registrations - -`talawa` is based on the original `quito` code created by the [Palisadoes Foundation][pfd] as part of its annual Calico Challenge program. Calico provides paid summer internships for Jamaican university students to work on selected open source projects. They are mentored by software professionals and receive stipends based on the completion of predefined milestones. Calico was started in 2015. Visit [The Palisadoes Foundation's website](http://www.palisadoes.org/) for more details on its origin and activities. - -# Table of Contents - -\