docs: sync all documentation to V3 config format#2766
Open
SiYue-ZO wants to merge 1 commit intosipeed:mainfrom
Open
docs: sync all documentation to V3 config format#2766SiYue-ZO wants to merge 1 commit intosipeed:mainfrom
SiYue-ZO wants to merge 1 commit intosipeed:mainfrom
Conversation
3 tasks
- Replace config/config.example.json with V3 format (version: 3, api_keys array, channel_list) - Update config-versioning.md: version 2→3, ConfigV2→ConfigV3, CurrentVersion=3 - Update 7 project READMEs: api_key→api_keys, add version: 3 to quick-start examples - Update 12 security docs (ANTIGRAVITY_AUTH + credential_encryption): api_key→api_keys - Update provider-refactoring.md: api_key→api_keys in all config examples - Update security_configuration.md: api_key→api_keys in Before example - Update 3 channel docs: channels→channel_list in JSON examples
SiYue-ZO
force-pushed
the
docs/v3-config-format-sync
branch
from
4259d75 to
e304dce
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
📝 Description
Sync all documentation to match the V3 config format. This PR updates 26 files across the codebase to align with the new V3 schema changes:
api_key(string) →api_keys(array),channels→channel_list, and version number 2 → 3.Changes include:
config/config.example.jsonwith V3 formatconfig-versioning.mdversion references and code examplesprovider-refactoring.mdandsecurity_configuration.mdchannels→channel_list🗣️ Type of Change
🤖 AI Code Generation
🔗 Related Issue
N/A — documentation sync for V3 config format migration.
📚 Technical Context (Skip for Docs)
Skipped — documentation-only change.
🧪 Test Environment
☑️ Checklist