Skip to content

CLI: Fix onboard advisory about configuration files#2490

Open
MichelSantos wants to merge 1 commit intosipeed:mainfrom
MichelSantos:fix/onboard-message
Open

CLI: Fix onboard advisory about configuration files#2490
MichelSantos wants to merge 1 commit intosipeed:mainfrom
MichelSantos:fix/onboard-message

Conversation

@MichelSantos
Copy link
Copy Markdown

📝 Description

The onboarding advisory includes steps that are incorrect since v0.2.5. The PR updates the onboarding advisories to discuss the configuration file and the security file.

🗣️ Type of Change

  • [☑️] 🐞 Bug fix (non-breaking change which fixes an issue)

🤖 AI Code Generation

  • [☑️] 👨‍💻 Mostly Human-written (Human lead, AI assisted or none)

Technical Context

The onboarding advisory includes steps that are incorrect since v0.2.5. That version began expecting API keys in the .security.yml file. The existing onboard message is:

Next steps:
1. Add your API key to <configPath>

However, the API key should be added to <securityPath>, and the LLM name should be indicated in the model_name field of the <configPath>.

The PR updates the onboarding advisories to:

Next steps:
  1. Add your selected LLM to the `model_name` field in <configPath>
  2. Add your API key to <securityPath>

The advisory step numbers also adapt to:

  • whether encryption is enabled, and
  • "plain" or "fancy" UI is being used.

☑️ Checklist

  • [☑️] My code/docs follow the style of this project.
  • [☑️] I have performed a self-review of my own changes.
  • I have updated the documentation accordingly.

@CLAassistant
Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@sipeed-bot sipeed-bot bot added type: bug Something isn't working domain: config labels Apr 12, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

domain: config type: bug Something isn't working

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants