Skip to content

Add full README documenting the Contribute API#12

Open
leogdion wants to merge 1 commit into
brightdigit-com-260621from
docs/readme-260629
Open

Add full README documenting the Contribute API#12
leogdion wants to merge 1 commit into
brightdigit-com-260621from
docs/readme-260629

Conversation

@leogdion

Copy link
Copy Markdown
Member

Replaces the one-line stub README with complete documentation generated from the actual source on brightdigit-com-260621.

What's included

  • What Contribute does / doesn't do — turns already-decoded source models into markdown files with YAML front matter; it does not fetch from APIs (you bring the source models).
  • The trioFrontMatterTranslator, MarkdownExtractor, and ContentType (the binder), with the real protocol declarations.
  • Installation + SPM snippet.
  • Quick start — a runnable RSS example using HTMLSource + the built-in FilteredHTMLMarkdownExtractor and SwiftSoupMarkdownGenerator.
  • Adding another source — same shape, different mappings.
  • What's in the boxSwiftSoupMarkdownGenerator, PassthroughMarkdownGenerator, FilteredHTMLMarkdownExtractor, FrontMatterYAMLExporter, FileNameGenerator/ContentURLGenerator, MarkdownContentBuilderOptions.
  • Requirements — Swift 5.8+, macOS 12 / iOS 13 / tvOS 13 / watchOS 6.

All API names, signatures, options, and platform/Swift versions were taken directly from the source on this branch.

🤖 Generated with Claude Code

Replace the one-line stub with a complete README: what Contribute does
and doesn't do (source model → markdown, no fetching), the FrontMatterTranslator
/ MarkdownExtractor / ContentType trio, installation, a runnable RSS quick
start, how to add another source, the provided helpers, and requirements.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Jun 29, 2026

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: a534806c-2fb9-4d6c-a558-be0185dc22c8

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/readme-260629

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant