conductor-oss / conductor-oss/javascript-sdk
Stale "Agentspan" product-name references in agents READMEs 🐛
- Dominant language
- TypeScript
- Stars
- 58
- Forks
- 20
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 7
Description
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).
Contributor guide
No contributing guide indexed for this repository
Research direction
Start with the listed README files under examples/agents and run grep -rin agentspan to find the additional comments and documentation references. Replace only the prose and product-name usages, preserving the _agentspan metadata property noted in the issue. Review the diff and confirm the stale user-facing references are gone without changing the serializer property.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Active
- Clarity
- Clearly specified
- Newbie friendliness
- 82/100