Skip to content

Update README.md #21

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

Merged
tekrajchhetri merged 1 commit into from
Aug 15, 2025
Merged

Update README.md #21

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
7 changes: 6 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,12 @@ The work has since been extended to include the following:

## Architecture

### Core pipeline
![](architecture.png)

### UI
Contains the NextJS code for visualization.
Comment on lines +34 to +35
Copy link

@gemini-code-assist gemini-code-assist bot Aug 15, 2025

Choose a reason for hiding this comment

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

medium

There's a trailing space in the 'UI' subheading which should be removed. To improve navigation and provide more context, consider adding a link to the UI's specific README.md file, which contains detailed setup and usage instructions.

Suggested change
### UI
Contains the NextJS code for visualization.
### UI
Contains the NextJS code for visualization. For more details, see the [UI README](./ui/README.md).


## 🛠 How It Works?

1. **People of BBQS** submit updates via Slack.
Expand All @@ -40,6 +44,7 @@ The work has since been extended to include the following:
- Calls LLM for ontology mapping.
- Stores outputs in **CSV** + **JSON** formats.
5. Results are committed back to the **GitHub repository**.
6. Visualize the data in a user friendly manner.
Copy link

@gemini-code-assist gemini-code-assist bot Aug 15, 2025

Choose a reason for hiding this comment

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

medium

This new step accurately reflects the addition of the UI. However, to be consistent with the other steps that describe how things work, you could make this more specific by mentioning the UI component that performs the visualization.

Suggested change
6. Visualize the data in a user friendly manner.
6. The processed data is visualized through the Next.js UI application.


## 💡 What’s New in This Release?

Expand All @@ -56,4 +61,4 @@ The work has since been extended to include the following:


## License
- MIT
- MIT