Skip to content

feat(codegen): generate embedder config reference for CLI docs#940

Merged
pyramation merged 1 commit intomainfrom
devin/1774944693-embedder-config-docs
Mar 31, 2026
Merged

feat(codegen): generate embedder config reference for CLI docs#940
pyramation merged 1 commit intomainfrom
devin/1774944693-embedder-config-docs

Conversation

@pyramation
Copy link
Copy Markdown
Contributor

Summary

Adds a one-time embedder.md skill reference to the CLI docs generator, produced alongside the existing context.md, auth.md, and config.md infrastructure references. The reference is only generated when any table in the schema has Vector fields (detected via categorizeSpecialFields with category === 'embedding').

Both codegen paths are updated:

  • generateSkills (single-target CLIs)
  • generateMultiTargetSkills (multi-target CLIs like csdk)

The generated reference includes two examples:

  1. Ollama + nomic-embed-text on localhost (open-source, local)
  2. OpenAI with an API key

Review & Testing Checklist for Human

  • OpenAI provider not yet implemented in runtime: The examples reference openai as a supported provider and embedder.apiKey as a config key, but templates/embedder.ts only handles ollama in buildEmbedder() and EmbedderConfig has no apiKey field. Decide whether these examples should be aspirational or removed until runtime support lands.
  • Verify generated output: Run codegen against a schema with Vector fields (e.g. agentic-db) and confirm embedder.md appears exactly once in the skill references directory, not duplicated per-table.
  • tables[0] access in single-target path: When hasEmbeddings is true, tables[0] is used for the example command. This should always be safe (embedding implies ≥1 table), but worth a glance.

Notes

  • The duplication between single-target and multi-target blocks follows the existing pattern used by context/auth/config references in the same file.
  • After this merges, re-running codegen on agentic-db will produce the embedder configuration docs automatically.

Link to Devin session: https://app.devin.ai/sessions/dadc6f4634e844739846793b8c75ca86
Requested by: @pyramation

Add a one-time embedder configuration skill reference (embedder.md)
that is generated alongside context.md, auth.md, and config.md when
any table in the schema has Vector fields.

Includes two examples:
- Ollama with nomic-embed-text on localhost (open-source)
- OpenAI with API key

Supports both single-target (generateSkills) and multi-target
(generateMultiTargetSkills) codegen paths.
@devin-ai-integration
Copy link
Copy Markdown
Contributor

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

@pyramation pyramation merged commit 3a384bc into main Mar 31, 2026
46 checks passed
@pyramation pyramation deleted the devin/1774944693-embedder-config-docs branch March 31, 2026 08:30
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.

1 participant