docs: correct built-in KB dump list and collection-name guidance#23
Conversation
The install form's "Built-in KnowledgeBase File" selector listed two obsolete dumps (docvec_gte_cs2000/cs3000, described by chunk size). The v1.4 chart (plugin-config.yaml) actually offers three dumps keyed to ACP documentation version, defaulting to acp_4_3: - docvec_gte_acp_4_1_20260508.dump (ACP 4.1) - docvec_gte_acp_4_2_20260508.dump (ACP 4.2) - docvec_gte_acp_4_3_20260508.dump (ACP 4.3, default) Also fix the "PG collection name" guidance: it must match the selected dump's internal collection name (filename without .dump). Since the first-start restore loads the dump as-is without renaming the collection (init-database.sh), selecting a non-default dump while leaving the collection name at its acp_4_3 default silently breaks retrieval. Added a NOTE covering this. Fix the same stale cs2000 name in the upgrade doc's example swap log (final name is PG_COLLECTION_NAME, default docvec_gte_acp_4_3_20260508).
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. 🗂️ Base branches to auto review (3)
Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Pull request overview
This PR corrects v1.4 installation and upgrade documentation for the bundled knowledge base dump names and the required PGVector collection-name relationship.
Changes:
- Replaces obsolete
cs2000/cs3000dump references with ACP 4.1/4.2/4.3 built-in dump options. - Clarifies that PG collection name must match the selected dump filename without
.dump. - Updates the upgrade verification log example to show the current default final collection name.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
docs/en/install.mdx |
Updates install guidance for built-in KB dump selection and PG collection naming. |
docs/en/upgrade/index.mdx |
Corrects the sample upgrade swap log output. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Deploying alauda-hyperflux with
|
| Latest commit: |
c014c03
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://3f249a7a.alauda-hyperflux.pages.dev |
| Branch Preview URL: | https://docs-fix-builtin-kb-dump-lis.alauda-hyperflux.pages.dev |
What
Fixes inaccuracies in the v1.4 install/upgrade docs, all tracing to the obsolete
cs2000/cs3000dump naming. Verified against therelease-1.4chart inalauda/aml/smart-doc.docs/en/install.mdxcharts/smart-doc/scripts/plugin-config.yamlactually offers three dumps keyed to ACP documentation version, defaulting toacp_4_3:docvec_gte_acp_4_1_20260508.dump— ACP 4.1 corpusdocvec_gte_acp_4_2_20260508.dump— ACP 4.2 corpusdocvec_gte_acp_4_3_20260508.dump(default) — ACP 4.3 corpus.dump). Because the first-start restore (init-database.sh:20-30) loads the dump without renaming the collection, picking a non-default dump while leaving the collection name at itsacp_4_3default silently breaks retrieval. Added a NOTE.docs/en/upgrade/index.mdxfinal name=docvec_gte_cs2000_20260410; the script prints${PG_COLLECTION_NAME}(defaultdocvec_gte_acp_4_3_20260508). Corrected.Verification
plugin-config.yaml:221-224,values.yaml:150values.yaml:77-80,plugin-config.yaml:200files/init-database.sh:20-30builder/data/repos-acp-4.{1,2,3}-*.jsonkb_versioncs2000/cs3000references remain anywhere underdocs/🤖 Generated with Claude Code