# 📚 selection-capture Documentation
Welcome to the complete documentation hub for `selection-capture`!
---
## 🗂️ Documentation Structure
### **📖 For Users** → [`docs/guides/`](docs/guides/)
User-facing guides and quick-start materials
- **Quick Start Publishing** - How to publish your first release
- **Social Media Posts** - Ready-to-use posts for announcing your release
- **Release Success Guide** - What to do after publishing
- **Project Setup Summary** - Overview of the complete setup
---
### **🤝 For Contributors** → [`docs/contributing/`](docs/contributing/)
Everything you need to know about contributing
- **Contributing Guide** - How to contribute (bug reports, PRs, etc.)
- **Code of Conduct** - Community standards and enforcement
- **Security Policy** - Reporting vulnerabilities and security practices
---
### **🚀 For Maintainers** → [`docs/release/`](docs/release/)
Release automation and publishing workflows
- **Release Guide** - Comprehensive guide to releasing versions
- **Quick Start Publishing** - Fast-track to first release
- **README Release** - Release system overview
- **Releases** - Release process and history
- **Configuration Files** - `release.toml`, `cliff.toml`
---
### **⚙️ Technical Documentation** → [`docs/technical/`](docs/technical/)
Deep technical guides and architecture
- **Development Guide** - Architecture, testing, code style
- **Roadmap 2026-2027** - Strategic planning and future features
- **Competitive Analysis** - Market landscape and positioning
- **Cross-Platform Testing** - How to test without physical machines
- **SPEC** - Technical specification and design decisions
---
### **📜 Reference Materials** → [`docs/reference/`](docs/reference/)
Legal and citation documents
- **Citation** - Academic citation file (CITATION.cff)
- **Apache License** - LICENSE-APACHE (dual-licensed with MIT)
---
## 🎯 Quick Navigation
### **I want to...**
#### **Use the library**
→ Start with [README.md](../README.md) in the root
→ Check out [Quick Start Guide](docs/guides/QUICKSTART_PUBLISH.md)
#### **Contribute to the project**
→ Read [Contributing Guide](docs/contributing/CONTRIBUTING.md)
→ Review [Code of Conduct](docs/contributing/CODE_OF_CONDUCT.md)
#### **Release a new version**
→ Follow [Release Guide](docs/release/RELEASE_GUIDE.md)
→ Use [Release Checklist](docs/guides/RELEASE_SUCCESS.md)
#### **Understand the architecture**
→ Study [Development Guide](docs/technical/DEVELOPMENT.md)
→ Review [Technical SPEC](docs/technical/SPEC.md)
#### **Plan contributions**
→ Check [Roadmap](docs/technical/ROADMAP_2026_2027.md)
→ Analyze [Competitive Landscape](docs/technical/COMPETITIVE_ANALYSIS.md)
#### **Test on multiple platforms**
→ Follow [Cross-Platform Testing Guide](docs/technical/CROSS_PLATFORM_TESTING.md)
#### **Announce the project**
→ Use [Social Media Templates](docs/guides/SOCIAL_MEDIA_POSTS.md)
---
## 📋 File Index
### Root Level (Essential Files)
These files stay in the root directory for maximum visibility:
- **README.md** - Main project overview
- **CHANGELOG.md** - Version history
- **LICENSE** - MIT License (primary license)
- **Cargo.toml** - Package configuration
- **Makefile** - Build commands
### docs/guides/
- CHECKLIST.md
- PROJECT_SETUP_SUMMARY.md
- QUICKSTART_PUBLISH.md
- RELEASE_SUCCESS.md
- SOCIAL_MEDIA_POSTS.md
### docs/contributing/
- CODE_OF_CONDUCT.md
- CONTRIBUTING.md
- SECURITY.md
### docs/release/
- README_RELEASE.md
- RELEASES.md
- RELEASE_GUIDE.md
- cliff.toml
- release.toml
### docs/technical/
- COMPETITIVE_ANALYSIS.md
- CROSS_PLATFORM_TESTING.md
- DEVELOPMENT.md
- ROADMAP_2026_2027.md
- SPEC.md
### docs/reference/
- CITATION.cff
- LICENSE-APACHE
---
## 🔗 External Links
- **Crates.io**: https://crates.io/crates/selection-capture
- **Documentation**: https://docs.rs/selection-capture
- **GitHub**: https://github.com/maemreyo/selection-capture
- **Repository**: https://github.com/maemreyo/selection-capture
---
## 📞 Contact & Support
### **Questions?**
- Open an issue on GitHub
- Check existing documentation
- Join community discussions
### **Security Issues?**
- Email: zaob.ogn@gmail.com
- See [Security Policy](docs/contributing/SECURITY.md)
### **Want to Contribute?**
- Read [Contributing Guide](docs/contributing/CONTRIBUTING.md)
- Pick a "good first issue"
- Submit a pull request
---
## 🎓 Documentation Standards
This documentation follows best practices:
✅ **Clear organization** - Logical folder structure
✅ **Audience-specific** - Separate sections for users/contributors/maintainers
✅ **Searchable** - Descriptive filenames and indexes
✅ **Cross-referenced** - Easy navigation between related docs
✅ **Version-controlled** - All docs in git history
✅ **Accessible** - Plain text markdown, no proprietary formats
---
## 🔄 Updating This Documentation
To add or reorganize documentation:
1. Create/edit file in appropriate `docs/<category>/` folder
2. Update this index if adding new sections
3. Cross-reference from related documents
4. Commit with descriptive message
Example:
```bash
git add docs/guides/my-new-guide.md
git commit -m "docs: add guide for my-new-guide"
git push
```
---
## 📊 Documentation Metrics
| **Guides** | 5 | ~1,900 | User onboarding |
| **Contributing** | 3 | ~500 | Community guidelines |
| **Release** | 5 | ~1,200 | Publishing workflows |
| **Technical** | 5 | ~2,800 | Deep technical content |
| **Reference** | 2 | ~250 | Legal & citation |
| **Total** | **20** | **~6,650** | **Complete coverage** |
---
## 🌟 Acknowledgments
This documentation structure was inspired by:
- [Rust Project Guidelines](https://doc.rust-lang.org/cargo/)
- [Keep a Changelog](https://keepachangelog.com/)
- [Common Readme Standards](https://makeareadme.com/)
- Best practices from successful Rust crates
---
*Last updated: 2026-03-29*
*Version: 1.0 (Initial organization)*
*Maintained by: zamery <zaob.ogn@gmail.com>*
---
**Happy reading! 📖**