-
Notifications
You must be signed in to change notification settings - Fork 1
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationnew featureIssues or PRs for a new feature that doesn't currently existIssues or PRs for a new feature that doesn't currently exist
Milestone
Description
Summary
Add docs/language-adapters-guide.md — a step-by-step guide for adding new language support (grammars, miners, framework detection) to the discovery pipeline.
Content
The guide has been drafted and committed to the repo. It covers:
- Registering a new
SupportedLanguageenum member - Adding the tree-sitter grammar package and loader
- Extending
FrameworkDetectorfor the new language - Creating miners (test functions, API routes) with
MinerContextand typed metadata - Registering miners in
build_default_pipeline() - Test fixture strategy
- Full checklist for new adapters
MinerContextreference table- Configuration via
pyproject.toml - Future enhancements (entry points, shared conftest, caching, traceability decoupling)
Uses Go as the running example throughout.
File
docs/language-adapters-guide.md (already drafted in repo)
Acceptance criteria
- Guide is technically accurate against the implemented discovery pipeline APIs
- All code examples compile/validate against the actual models (Discovery: DiscoveredItem data models and pipeline contracts #124) and protocol (Discovery: pipeline orchestrator #126)
-
MinerContextreference matches the implementedcontext.py - Typed metadata examples match
TestFunctionMeta,ApiRouteMetafrom Discovery: DiscoveredItem data models and pipeline contracts #124 - Linked from
docs/index.mdunder a new "Extending SpecLeft" section - Reviewed for consistency with existing docs style (
docs/spec-format.md,docs/agent-contract.md)
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationnew featureIssues or PRs for a new feature that doesn't currently existIssues or PRs for a new feature that doesn't currently exist