Skip to content

Feat/Dev tools enhancement#519

Open
LaansDole wants to merge 12 commits intoOpenBMB:mainfrom
LaansDole:main
Open

Feat/Dev tools enhancement#519
LaansDole wants to merge 12 commits intoOpenBMB:mainfrom
LaansDole:main

Conversation

@LaansDole
Copy link

@LaansDole LaansDole commented Jan 21, 2026

  • Update README.md with make commands from Makefile
  • Implement dev tools, include a tool to read all YAML files and uploads them to the VueGraph database.
  • Replace .env with .env.example and hide .env in .gitignore, which is a better practice because why not

Copy link
Collaborator

@NA-Wen NA-Wen left a comment

Choose a reason for hiding this comment

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

Hi LaansDole,

Thank you so much for this wonderful contribution! I really appreciate the time and effort you've put into improving the developer experience with the new Makefile, dev tools, and documentation updates.

I've reviewed the PR and most of the changes look great. However, I'd like to kindly suggest a few adjustments:

1. Changes to check/check.py
Would it be possible to revert the modifications to check/check.py? It seems these changes might not be directly related to the main goals of this PR.

2. Modifications to yaml_instance/ files
I'd like to respectfully ask if we could revert the changes to the YAML files in the yaml_instance/ directory. The reason is that we intentionally designed the system to allow users the flexibility to specify different model names for different agents directly in their YAML configurations. By using a centralized .env variable, we might limit this flexibility. We believe giving users more control over individual agent configurations is important for the project's use cases.

Would you be able to update the PR to address these points? I'm really excited about merging the core improvements you've made. Thank you again for your contribution and understanding! 😊

@LaansDole LaansDole requested a review from NA-Wen January 22, 2026 15:48
@LaansDole
Copy link
Author

Hi LaansDole,

Thank you so much for this wonderful contribution! I really appreciate the time and effort you've put into improving the developer experience with the new Makefile, dev tools, and documentation updates.

I've reviewed the PR and most of the changes look great. However, I'd like to kindly suggest a few adjustments:

1. Changes to check/check.py Would it be possible to revert the modifications to check/check.py? It seems these changes might not be directly related to the main goals of this PR.

2. Modifications to yaml_instance/ files I'd like to respectfully ask if we could revert the changes to the YAML files in the yaml_instance/ directory. The reason is that we intentionally designed the system to allow users the flexibility to specify different model names for different agents directly in their YAML configurations. By using a centralized .env variable, we might limit this flexibility. We believe giving users more control over individual agent configurations is important for the project's use cases.

Would you be able to update the PR to address these points? I'm really excited about merging the core improvements you've made. Thank you again for your contribution and understanding! 😊

I have reverted as per your suggestions

@LaansDole LaansDole changed the title Feat/Dev tools and centralising model name in YAML files Feat/Dev tools enhancement Feb 1, 2026
@zxrys
Copy link
Collaborator

zxrys commented Feb 6, 2026

Thank you for your pull request! Your Makefile greatly helps users get the application up and running! However, I think adding two tool scripts to the tools folder is pointless. Could you please delete these two files or explain their necessity? Also, your comments in .env.example are helpful, but there are some errors: For both OpenAI-compatible providers and providers with custom API types (e.g., Gemini), we use BASE_URL and API_KEY for specification. Therefore, I think the distinction between Option 1 and Option 2 is redundant; it's sufficient to explain that BASE_URL and API_KEY are configurations for model call authentication.

Please improve this PR based on my above points. After confirming everything is correct, I will merge the PR and add you to the contributor list.

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.

3 participants