[GH-ISSUE #1882] 🌟 [EPIC] Community Brainstorming: Documentation Improvement Initiative #739

New issue

Open

opened 2026-02-25 21:35:48 +03:00 by kerem · 2 comments

kerem commented

2026-02-25 21:35:48 +03:00

Owner

Originally created by @IrAlfred on GitHub (Feb 21, 2026).
Original GitHub issue: https://github.com/cypht-org/cypht/issues/1882

📚 Community Brainstorming: Documentation Improvement Initiative

🎯 Goal

Let's work together to identify gaps in our documentation and create a roadmap for improvements! Cypht is a powerful, modular email client with 35+ module sets, multiple authentication options, and extensive integration capabilities - but we need better docs to help everyone use and contribute to it effectively.

We want to hear from YOU - what documentation would help you most?

📋 Current Documentation Status

✅ What We Have

Main README - Project overview and basic links
CONTRIBUTING.md - Contribution guidelines and Git workflow
Installation Guide - Available on the website
GitHub Wiki - Several wiki pages
Module Information - Basic module descriptions
Module-specific README files in each of our 37 module directories
Inline comments in configuration files (config/app.php with config options!)
Hello World Module - Example module with commented code explaining the module system

How to Participate

We need YOUR perspective! Please comment below with:

What's Missing?

Missing topics - What's not documented at all? (e.g., "How do I set up LDAP auth?")
Unclear sections - Parts that confused you when first reading
Outdated content - Docs that don't match current Cypht behavior (wiki pages, READMEs, website)
Use case examples - Specific scenarios you'd like to see documented (e.g., "Setting up Cypht with Gmail OAuth2")
Wiki improvements - What should be added or expanded in the GitHub wiki?

What's Your Experience?

New user - What blocked you during setup?
Developer - What did you need to figure out from source code?
System administrator - What production issues weren't documented?
Contributor - What would have helped you write your first module?

Want to Help? 🙋

Write docs - Can you document an area you know well?
Review - Can you proofread and improve existing docs?
Share examples - Can you provide real-world configuration examples?

Next Steps

Community Input Phase ← We are here! Gather suggestions and priorities
Prioritization - Based on your feedback, we'll identify high-impact areas
Task Distribution - Break into manageable issues that volunteers can tackle
Implementation - Write, review, and publish documentation
Continuous Improvement - Keep docs updated with each release

💬 Discussion Guidelines

✅ Be specific about what you need (e.g., "I need docs on configuring Memcached sessions")
✅ Share your real experiences with Cypht
✅ No suggestion is too small - even one-page guides are valuable
✅ Link to examples from other projects if helpful
✅ Use reactions (👍) to show support for ideas

Let's make Cypht documentation the best it can be! 🚀

What documentation would make Cypht easier for you to use or contribute to? Comment below! 👇

Originally created by @IrAlfred on GitHub (Feb 21, 2026). Original GitHub issue: https://github.com/cypht-org/cypht/issues/1882 # 📚 Community Brainstorming: Documentation Improvement Initiative ## 🎯 Goal Let's work together to identify gaps in our documentation and create a roadmap for improvements! Cypht is a powerful, modular email client with 35+ module sets, multiple authentication options, and extensive integration capabilities - but we need better docs to help everyone use and contribute to it effectively. **We want to hear from YOU** - what documentation would help you most? --- ## 📋 Current Documentation Status ### ✅ What We Have - [Main README](README.md) - Project overview and basic links - [CONTRIBUTING.md](CONTRIBUTING.md) - Contribution guidelines and Git workflow - [Installation Guide](https://cypht.org/install) - Available on the website - [GitHub Wiki](https://github.com/cypht-org/cypht/wiki) - Several wiki pages - [Module Information](https://cypht.org/modules) - Basic module descriptions - Module-specific README files in each of our 37 module directories - Inline comments in configuration files (`config/app.php` with config options!) - [Hello World Module](modules/hello_world/) - Example module with commented code explaining the module system ## How to Participate We need YOUR perspective! Please comment below with: ### What's Missing? - **Missing topics** - What's not documented at all? (e.g., "How do I set up LDAP auth?") - **Unclear sections** - Parts that confused you when first reading - **Outdated content** - Docs that don't match current Cypht behavior (wiki pages, READMEs, website) - **Use case examples** - Specific scenarios you'd like to see documented (e.g., "Setting up Cypht with Gmail OAuth2") - **Wiki improvements** - What should be added or expanded in the [GitHub wiki](https://github.com/cypht-org/cypht/wiki)? ### What's Your Experience? - **New user** - What blocked you during setup? - **Developer** - What did you need to figure out from source code? - **System administrator** - What production issues weren't documented? - **Contributor** - What would have helped you write your first module? ### Want to Help? 🙋 - **Write docs** - Can you document an area you know well? - **Review** - Can you proofread and improve existing docs? - **Share examples** - Can you provide real-world configuration examples? --- ## Next Steps 1. **Community Input Phase** ← *We are here!* Gather suggestions and priorities 2. **Prioritization** - Based on your feedback, we'll identify high-impact areas 3. **Task Distribution** - Break into manageable issues that volunteers can tackle 4. **Implementation** - Write, review, and publish documentation 5. **Continuous Improvement** - Keep docs updated with each release --- ## 💬 Discussion Guidelines ✅ Be specific about what you need (e.g., "I need docs on configuring Memcached sessions") ✅ Share your real experiences with Cypht ✅ No suggestion is too small - even one-page guides are valuable ✅ Link to examples from other projects if helpful ✅ Use reactions (👍) to show support for ideas --- ## 🔗 Related Links - [Cypht Website](https://cypht.org) - [Installation Guide](https://cypht.org/install) - [Developer Documentation](https://www.cypht.org/developers-documentation/) - [GitHub Wiki](https://github.com/cypht-org/cypht/wiki) - Existing wiki pages - [CONTRIBUTING.md](CONTRIBUTING.md) --- **Let's make Cypht documentation the best it can be! 🚀** What documentation would make Cypht easier for you to use or contribute to? Comment below! 👇

kerem added the

epic

label

2026-02-25 21:35:48 +03:00

kerem commented

2026-02-25 21:35:48 +03:00

Author

Owner

@no-one commented on GitHub (Feb 23, 2026):

Thanks, that's a good idea!
Regarding the installation guide:

don't mix versions 1.x and 2.x, as this is confusing for new users
the differences between USER_CONFIG_TYPE db and file should be explained in more detail (for example, I don't think the need to run setup_database.php is mentioned anywhere but I think I had to?)
it would be good in general to know exactly what is stored where when using different settings for AUTH_TYPE, e.g., IMAP auth vs. DB auth

@no-one commented on GitHub (Feb 23, 2026): Thanks, that's a good idea! Regarding the installation guide: - don't mix versions 1.x and 2.x, as this is confusing for new users - the differences between `USER_CONFIG_TYPE` `db` and `file` should be explained in more detail (for example, I don't think the need to run `setup_database.php` is mentioned anywhere but I think I had to?) - it would be good in general to know exactly what is stored where when using different settings for `AUTH_TYPE`, e.g., IMAP auth vs. DB auth

kerem commented

2026-02-25 21:35:48 +03:00

Author

Owner

@IrAlfred commented on GitHub (Feb 24, 2026):

Thanks, that's a good idea! Regarding the installation guide:

don't mix versions 1.x and 2.x, as this is confusing for new users

the differences between USER_CONFIG_TYPE db and file should be explained in more detail (for example, I don't think the need to run setup_database.php is mentioned anywhere but I think I had to?)

it would be good in general to know exactly what is stored where when using different settings for AUTH_TYPE, e.g., IMAP auth vs. DB auth

Thank you @no-one !

@IrAlfred commented on GitHub (Feb 24, 2026): > Thanks, that's a good idea! Regarding the installation guide: > > * don't mix versions 1.x and 2.x, as this is confusing for new users > * the differences between `USER_CONFIG_TYPE` `db` and `file` should be explained in more detail (for example, I don't think the need to run `setup_database.php` is mentioned anywhere but I think I had to?) > * it would be good in general to know exactly what is stored where when using different settings for `AUTH_TYPE`, e.g., IMAP auth vs. DB auth Thank you @no-one !

kerem referenced this issue

2026-02-25 21:36:57 +03:00

[PR #739] [MERGED] Contact bubbles: make it possible to copy-paste and edit #1017