Skip to content

Updated Readme for local AI instructions #79

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

Open
sbddesign wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Updated Readme for local AI instructions #79

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ This is a project to improve the UX of BitDevs websites and add AI generated sum

## AI Scraper and Summarizer

The intended usage is that you use the AI scraper and sumamrizer as a GitHub action, which will be triggered anytime changes are pushed to the `main` or `master` branch.

[How to setup repository secrets](https://docs.github.com/en/actions/security-guides/encrypted-secrets)

- Add repository secret `OPENAI_API_KEY` -> your Open AI API Key
Expand All @@ -23,10 +25,10 @@ cd ai
# Make a .env file inside the ai directory and add your OPENAI_API_KEY

yarn install

yarn start
```

From there, your `/ai` directory has been configured. You should be able to return to the root website directory and then run `yarn summarize` to invoke the summarizer.

- It will pick markdown files inside `content/events` directory starting with a date in `yyyy-mm-dd`.
- Only the most recent file sorted by date will be summarized.
- Once the Github action finishes the building the summary, it will submit a PR to the repo. If the PR is merged, the repo builds and deploys to production and summaries are visible on the website.
Expand Down