Contributing

Thank you for your interest in contributing to ai-web-feeds. This page is the main contributor entry point and links to the deeper workflow guides that support the repository.

Quick Start

Use the repository-standard toolchain from the start:

git clone https://github.com/wyattowalsh/ai-web-feeds.git
cd ai-web-feeds

uv sync

cd apps/web
pnpm install
cd ../..

uv run pre-commit install
uv run pre-commit install --hook-type commit-msg
uv run pytest
uv run ai-web-feeds --help

Required Tooling

• Python commands use uv only.
• Node.js commands use pnpm only.
• Project documentation belongs in apps/web/content/docs/ as .mdx files.

Contribution Guides

These pages contain the detailed workflows that are now linked from the visible docs tree:

Documentation Notes

Documentation is built with Fumadocs and lives in apps/web/content/docs/.

When you add or move docs pages:

1. Create or update the .mdx file in the correct section.
2. Keep apps/web/content/docs/meta.json aligned with the visible docs graph.
3. Add title and description frontmatter so the page renders cleanly in navigation and metadata.

Common Next Steps

• For architecture and implementation context, continue to Development.
• For deployment and environment details, see Deployment.
• For issue tracking and discussion, use GitHub Issues and GitHub Discussions.

Repository Notes

The repository still supports a legacy SQLite filename, data/aiwebfeeds.db, for older local installs. New examples and setup steps should use data/ai-web-feeds.db.