Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs #14

Open
wants to merge 11 commits into
base: main
Choose a base branch
from
Open

docs #14

wants to merge 11 commits into from

Conversation

mdjastrzebski
Copy link
Member

Summary

Test plan

mdjastrzebski
mdjastrzebski commented Nov 18, 2024
View reviewed changes
docs/src/docs/about.md Outdated Show resolved Hide resolved
mdjastrzebski
mdjastrzebski commented Nov 18, 2024
View reviewed changes
docs/src/docs/about.md Outdated Show resolved Hide resolved
mdjastrzebski
mdjastrzebski commented Nov 19, 2024
View reviewed changes
docs/src/docs/integrations/discord-usage.md

:::danger
Discord implementation is still in progress, treat it as experimental.
:::
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add additional details how users can run this stuff

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added todo

mdjastrzebski
mdjastrzebski commented Nov 19, 2024
View reviewed changes
docs/src/docs/getting-started.mdx Outdated

<PackageManagerTabs command="install @callstack/byorg-core" />

In next section we'll show you how to use our core library to handle your requests.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should structure it slightly different.

  1. Bare setup
  • install ai @callstack/byorg-core
  1. Setup with Slack
  • install ai @callstack/byorg-core @callstack/byorg-slack
  1. Setup with Discord
  • install ai @callstack/byorg-core @callstack/byorg-discord

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that currently it might be very hard to setup slack from the ground up, so we should provide example projects (le'ts disicuss what exactly) and link to them. In the longer run we should have a create-byorg-app package that would generate these project for you, but starting with a example is a reasonable first step.

mdjastrzebski
mdjastrzebski commented Nov 26, 2024
View reviewed changes
docs/src/docs/about.md
This is main section about byorg-ai Framework
## Introduction

byorg.ai is a framework designed for the rapid development and deployment of AI assistants within companies and organizations.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

english: seems like 'the' is not supposed to be there

Suggested change
byorg.ai is a framework designed for the rapid development and deployment of AI assistants within companies and organizations.
byorg.ai is a framework designed for rapid development and deployment of AI assistants within companies and organizations.

mdjastrzebski
mdjastrzebski commented Nov 26, 2024
View reviewed changes
docs/src/docs/core/usage.mdx
systemPrompt,
});
```
### Run processing message
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
### Run processing message
### Process user messages

mdjastrzebski
mdjastrzebski commented Nov 26, 2024
View reviewed changes
docs/src/docs/integrations/slack-usage.md
@@ -0,0 +1,62 @@
## Integrating with Slack

Byorg provides built-in functionality to integrate your application with Slack. To set this up, use the `createSlackApp` function and provide the necessary parameters.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mention that we also provide traslation between Slack events and byorg events, as well as custom formatter for slack blocks (add links to slack docs) that uses slack-rich-text package.

@mdjastrzebski
Copy link
Member Author

Pls remove the API top-level tab for now, as we are not using it.

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

@Q1w1N Q1w1N Q1w1N left review comments

At least 1 approving review is required to merge this pull request.

Assignees

@Q1w1N Q1w1N

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@mdjastrzebski @Q1w1N