Moves docs to this repo

[elliotBraem]

Summary by CodeRabbit

• Documentation

  • Comprehensive new documentation covering installation, development, deployment, plugin usage, and content curation workflows.
  • New guides and categories improve navigation for both curators and developers.

• New Features

  • Refreshed homepage with enhanced feature highlights.
  • Updated deployment and configuration instructions streamline onboarding and site management.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
curatedotfun-docs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Mar 11, 2025 6:12pm

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

This pull request introduces a comprehensive set of new documentation pages, configuration files, and source code enhancements for the Curate.fun platform. New guides cover installation, development, deployment, and advanced plugin workflows, while configuration files (for Docusaurus, Babel, TypeScript, etc.) and styling assets improve the docs site structure and presentation. Additionally, new UI components and workspace updates have been added along with Git and Prettier ignore configurations to streamline project management.

Changes

File(s)	Change Summary
docs/.gitignore, .prettierignore	Added files to ignore dependency directories, build artifacts, and other generated files for Git and Prettier.
docs/README.md, docs/babel.config.js	Introduced a new README for installation, development, building, and deployment; added Babel configuration for Docusaurus.
docs/docusaurus.config.ts, docs/package.json, docs/sidebars.ts, docs/tsconfig.json, docs/static/site.webmanifest	New configuration files for Docusaurus site setup, TypeScript settings, sidebar navigation, and web manifest metadata.
docs/docs/developers/_category_.json, docs/docs/developers/configuration.md, docs/docs/developers/deployment.md, docs/docs/developers/plugins.md	New developer documentation covering configuration, deployment with Fly.io, and plugin development with interface definitions.
docs/docs/getting-started.md, docs/docs/intro.md	Added general guides and introductory content for platform users.
docs/docs/plugins/_category_.json, docs/docs/plugins/build-plugin.md, docs/docs/plugins/index.md, and all files under docs/docs/plugins/distributors/, docs/docs/plugins/sources/, docs/docs/plugins/transformers/	New plugin documentation including categories, building custom plugins, and detailed guides for distributor, source, and transformer plugins.
docs/docs/user-guides/_category_.json, docs/docs/user-guides/content-cookbook.md, docs/docs/user-guides/curation.md, docs/docs/user-guides/using-plugins.md	New user guide documents covering content workflows, curator instructions, and plugin usage.
docs/src/components/HomepageFeatures/*, docs/src/css/custom.css, docs/src/pages/index.*, docs/src/pages/markdown-page.md	Introduced new React components, CSS modules, and markdown pages for homepage features and styling.
package.json (root)	Updated workspace configuration and added script commands for starting, building, and serving the docs site.

Sequence Diagram(s)

sequenceDiagram
    participant U as User
    participant PF as Platform
    participant SP as Source Plugin
    participant TP as Transformer Plugin
    participant DP as Distributor Plugin
    participant CH as Channel

    U->>PF: Submit content / trigger update
    PF->>SP: Fetch/monitor content
    SP->>PF: Return raw content
    PF->>TP: Process and transform content
    TP->>PF: Return transformed content
    PF->>DP: Deliver content for distribution
    DP->>CH: Publish content to channel

Loading

Poem

I hopped through docs with gentle grace,
Adding guides and configs in every space.
From plugins to pages, each line is new,
A rabbit’s delight in code fresh as dew.
With a twitch of my whiskers, I cheer in rhyme—
Our updates hop forward, one commit at a time!
🐇✨

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between db01eac and 484c12e.

⛔ Files ignored due to path filters (11)

• bun.lockb is excluded by !**/bun.lockb
• docs/docs/plugins/distributors/a691e5a6ef6d58047babee6c4b437f0696a90562.svg is excluded by !**/*.svg
• docs/favicon.ico is excluded by !**/*.ico
• docs/static/img/apple-touch-icon.png is excluded by !**/*.png
• docs/static/img/favicon-96x96.png is excluded by !**/*.png
• docs/static/img/favicon.ico is excluded by !**/*.ico
• docs/static/img/favicon.svg is excluded by !**/*.svg
• docs/static/img/logo.png is excluded by !**/*.png
• docs/static/img/meta.png is excluded by !**/*.png
• docs/static/img/web-app-manifest-192x192.png is excluded by !**/*.png
• docs/static/img/web-app-manifest-512x512.png is excluded by !**/*.png

📒 Files selected for processing (44)

• docs/.gitignore (1 hunks)
• docs/README.md (1 hunks)
• docs/babel.config.js (1 hunks)
• docs/docs/developers/_category_.json (1 hunks)
• docs/docs/developers/configuration.md (1 hunks)
• docs/docs/developers/deployment.md (1 hunks)
• docs/docs/developers/plugins.md (1 hunks)
• docs/docs/getting-started.md (1 hunks)
• docs/docs/intro.md (1 hunks)
• docs/docs/plugins/_category_.json (1 hunks)
• docs/docs/plugins/build-plugin.md (1 hunks)
• docs/docs/plugins/distributors/_category_.json (1 hunks)
• docs/docs/plugins/distributors/index.md (1 hunks)
• docs/docs/plugins/distributors/near-social.md (1 hunks)
• docs/docs/plugins/distributors/notion.md (1 hunks)
• docs/docs/plugins/distributors/rss.md (1 hunks)
• docs/docs/plugins/distributors/supabase.md (1 hunks)
• docs/docs/plugins/distributors/telegram.md (1 hunks)
• docs/docs/plugins/index.md (1 hunks)
• docs/docs/plugins/sources/_category_.json (1 hunks)
• docs/docs/plugins/sources/index.md (1 hunks)
• docs/docs/plugins/sources/twitter.md (1 hunks)
• docs/docs/plugins/transformers/_category_.json (1 hunks)
• docs/docs/plugins/transformers/ai-transform.md (1 hunks)
• docs/docs/plugins/transformers/index.md (1 hunks)
• docs/docs/plugins/transformers/object-transform.md (1 hunks)
• docs/docs/plugins/transformers/simple-transform.md (1 hunks)
• docs/docs/user-guides/_category_.json (1 hunks)
• docs/docs/user-guides/content-cookbook.md (1 hunks)
• docs/docs/user-guides/curation.md (1 hunks)
• docs/docs/user-guides/using-plugins.md (1 hunks)
• docs/docusaurus.config.ts (1 hunks)
• docs/package.json (1 hunks)
• docs/sidebars.ts (1 hunks)
• docs/src/components/HomepageFeatures/index.tsx (1 hunks)
• docs/src/components/HomepageFeatures/styles.module.css (1 hunks)
• docs/src/css/custom.css (1 hunks)
• docs/src/pages/index.module.css (1 hunks)
• docs/src/pages/index.tsx (1 hunks)
• docs/src/pages/markdown-page.md (1 hunks)
• docs/static/site.webmanifest (1 hunks)
• docs/tsconfig.json (1 hunks)
• package.json (1 hunks)
• .prettierignore (1 hunks)

✨ Finishing Touches

• 📝 Generate Docstrings

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.