The current doc files for the project, frontend, and backend don't fully capture the essence and unique features of our chat messaging app. We need to revise them to better represent the goals of the application in terms of safety, privacy and the benefits of self-hosting.
Tasks:
Overall Project:
[ ] Add/Update the introduction to highlight the app's self-hosted nature and its benefits.
[ ] Elaborate on the unique value proposition of personal unrestricted access to stored data and communication.
[ ] Mention security features and our commitment to user safety.
[ ] Update the setup and installation instructions, emphasizing the self-hosted nature.
[ ] Add visuals (screenshots or diagrams) of the app to provide a quick overview to new visitors.
Frontend API:
[ ] Describe the frontend architecture and technologies used.
[ ] Emphasize any frontend features that enhance user safety and privacy.
[ ] Provide clear instructions on setting up the frontend locally and any nuances related to the self-hosted model.
[ ] Add/Update FAQs specific to the frontend, addressing common queries and potential challenges.
Backend API:
[ ] Elaborate on the backend's role in ensuring personal unrestricted access to data.
[ ] Describe the backend technologies and how they contribute to user safety and data integrity.
[ ] Update instructions for backend setup, focusing on the self-hosted aspect.
General:
[ ] Ensure consistency in style and language across all doc files.
[ ] Include a section or link about community guidelines, emphasizing respectful communication given the unrestricted nature of the app.
[ ] Seek feedback from both new and existing users on clarity and comprehensiveness of the READMEs, making further adjustments as necessary.
The current doc files for the project, frontend, and backend don't fully capture the essence and unique features of our chat messaging app. We need to revise them to better represent the goals of the application in terms of safety, privacy and the benefits of self-hosting.
Tasks: