conductor-oss / conductor-oss/javascript-sdk
Stale "Agentspan" product-name references in agents READMEs 🐛
- Lenguaje dominante
- TypeScript
- Estrellas
- 58
- Forks
- 20
- Merge medio
- 1 d 13 h
- PR fusionados (30 d)
- 7
Descripción
The old product name **"Agentspan"** still appears in several of the agents example READMEs. It should be scrubbed from user-facing docs (the public API/error hierarchy already dropped it — see `AgentspanError` → `ConductorAgentError` in the CHANGELOG).
### Where
| File | Lines | Snippet |
|------|-------|---------|
| `examples/agents/langgraph/README.md` | 3, 63, 85, 109, 147, 162, 186 | "Add agentspan metadata", "add agentspan import", "After (**Agentspan**)" |
| `examples/agents/vercel-ai/README.md` | 68, 113 | "builds a **Agentspan** `Agent`", "// agentspan Agent + Runtime" |
| `examples/agents/adk/README.md` | 57 | "// ^^^ add agentspan import" |
| `examples/agents/openai/README.md` | 51 | "// ^^^ add agentspan import" |
### Note for whoever fixes this
Not every hit is a product-name leak. The `(graph as any)._agentspan = { ... }` metadata property (langgraph README, `docs/agents/frameworks/langgraph.md`, `langchain.md`) is a **real internal property** the serializer reads — leave that one alone. Only the prose/product-name usages ("Agentspan", "add agentspan import", "After (Agentspan)") should be reworded.
There are also a few non-README hits (`examples/agents/*.ts` comments, `AGENTS.md`, `eslint.config.mjs`) worth sweeping while you're in there — `grep -rin agentspan` finds them all.
---
Refiled on behalf of @maria-shimkovska from conductor-oss/conductor#1536 (moved here since the references live in this repo).
Guía de contribución
No hay ninguna guía de contribución indexada para este repositorio
Línea de trabajo
Comienza con los archivos README indicados en examples/agents y ejecuta grep -rin agentspan para encontrar los comentarios adicionales y las referencias en la documentación. Reemplaza únicamente la prosa y los usos del nombre del producto, conservando la propiedad de metadatos _agentspan mencionada en el issue. Revisa el diff y confirma que las referencias obsoletas visibles para el usuario hayan desaparecido sin cambiar la propiedad del serializer.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- typescript
- Área
- documentation
- Tipo de issue
- Documentación
- Dificultad
- 2/5
- Tiempo estimado
- 1-3 horas
- Estado de actividad
- Activo
- Claridad
- Bien especificado
- Aptitud para principiantes
- 82/100