# RSSCopilot Documentation

[![zotero target version](https://img.shields.io/badge/Zotero-7-green?style=flat-square&logo=zotero&logoColor=CC2936)](https://www.zotero.org)
[![Using Zotero Plugin Template](https://img.shields.io/badge/Using-Zotero%20Plugin%20Template-blue?style=flat-square&logo=github)](https://github.com/windingwind/zotero-plugin-template)
[![license](https://img.shields.io/github/license/etShaw-zh/rsscopilot)](https://github.com/etShaw-zh/rsscopilot/blob/master/LICENSE)
[![Documentation Status](https://readthedocs.org/projects/rsscopilot/badge/?version=latest)](https://rsscopilot.readthedocs.io/en/latest/?badge=latest)


Welcome to the RSSCopilot documentation! RSSCopilot is a Zotero plugin that enhances the built-in RSS functionality by providing intelligent relevance analysis of RSS feed items based on your existing library.

## Features

### Intelligent Relevance Analysis

- Calculate relevance scores for RSS items based on your existing library
- Support for multiple language models
- Visual indicators for relevance levels

### Enhanced RSS Management

- Add and organize RSS feeds
- Sort items by relevance
- Quick actions for saving and marking items

### User-Friendly Interface

- Seamless integration with Zotero
- Intuitive configuration options
- Responsive and efficient

```{toctree}
:maxdepth: 2
:caption: Documentation Contents

user-guide/index
dev-guide/index
project/index
```

## Getting Help

If you need help with RSSCopilot, you can:

1. Check the [FAQ](user-guide/faq.md)
2. Browse the [documentation](user-guide/index.md)
3. Report issues on [GitHub](https://github.com/etShaw-zh/RSSCopilot/issues)

## Contributing

We welcome contributions! Please see our [Contributing Guide](dev-guide/contributing.md) for details on how to get started.

## Acknowledgments

This project would not be possible without the following excellent open source projects:

- [Zotero](https://github.com/zotero/zotero) - A free, easy-to-use tool to help you collect, organize, cite, and share research.
- [sqlite-vec](https://github.com/asg017/sqlite-vec) - A SQLite extension for vector search and vector calculations.
- [zotero-plugin-template](https://github.com/windingwind/zotero-plugin-template) - A template for Zotero plugin development.

We are deeply grateful to the maintainers and contributors of these projects.