docs: enhance README with technical architecture details #65
+98
−6
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
0x4007
requested changes
Feb 6, 2025
|
Resolves ubiquity-os-marketplace/.github#4 |
This must be in the pull body so you need to edit the top comment. |
shiv810
reviewed
Feb 6, 2025
Comment on lines
+28
to
+31
| ┌─────────────────┐ ┌──────────────┐ | ||
| │ GitHub Webhook │ ──────> │ Cloudflare │ | ||
| │ (Comments) │ │ Worker │ | ||
| └─────────────────┘ └──────┬───────┘ |
There was a problem hiding this comment.
Suggested change
| ┌─────────────────┐ ┌──────────────┐ | |
| │ GitHub Webhook │ ──────> │ Cloudflare │ | |
| │ (Comments) │ │ Worker │ | |
| └─────────────────┘ └──────┬───────┘ | |
| ┌─────────────────┐ ┌──────────────┐ | |
| │ GitHub Webhook │ ──────> │ Github │ | |
| │ (Comments) │ │ Action │ | |
| └─────────────────┘ └──────┬───────┘ |
Shouldn't this be a GitHub Action, since it's more commonly used than worker deployment in most cases?
shiv810
reviewed
Feb 6, 2025
|
|
||
| ```yml | ||
| plugins: | ||
| - uses: | ||
| - plugin: http://localhost:4000 | ||
| with: | ||
| model: "" | ||
| openAiBaseUrl: "" | ||
| openRouterBaseUrl: "" |
There was a problem hiding this comment.
Suggested change
| openRouterBaseUrl: "" | |
| openAiBaseUrl: "" |
This is incorrect, it should be openAiBaseUrl.
There was a problem hiding this comment.
Shouldn't we switch every plugin to OpenRouter?
There was a problem hiding this comment.
Yes, we should be converting everywhere. Except for the Command-Ask andtelegram plugins, almost all other plugins use OpenAI and need to be converted.
shiv810
reviewed
Feb 6, 2025
|
|
||
| ```sh | ||
| OPENAI_API_KEY=your_openai_api_key | ||
| SUPABASE_URL=your_supabase_url | ||
| SUPABASE_KEY=your_supabase_key | ||
| VOYAGEAI_API_KEY=your_voyageai_api_key |
There was a problem hiding this comment.
Suggested change
| VOYAGEAI_API_KEY=your_voyageai_api_key | |
| VOYAGEAI_API_KEY=your_voyageai_api_key | |
| OPENROUTER_API_KEY=your_openrouter_key |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Resolves ubiquity-os-marketplace/.github#4