Initial contents
* Basic .gitignore * specification folder with * README.md * v1_problems.md * v2_scope.md * v2_tech_stack.md
This commit is contained in:
parent
d5fef7e868
commit
fb88a0c12d
1 changed files with 245 additions and 0 deletions
45
specification/README.md
Normal file
45
specification/README.md
Normal file
|
|
@ -0,0 +1,45 @@
|
|||
# Inspector V2 Brief
|
||||
|
||||
### Brief | [V1 Problems](v1_problems.md) | [V2 Scope](v2_scope.md) | [V2 Tech Stack](v2_tech_stack.md)
|
||||
|
||||
## Table of Contents
|
||||
* [Motivation and Context](#motivation-and-context)
|
||||
* [Track Protocol Conformance](#track-protocol-conformance)
|
||||
* [Improve Maintainability](#improve-maintainability)
|
||||
* [Provide Extensibility](#provide-extensibility)
|
||||
* [Proper Documentation](#proper-documentation)
|
||||
|
||||
## Motivation and Context
|
||||
|
||||
The existing Inspector is hard to maintain for a number of reasons. We decided to create a more maintainable Inspector
|
||||
from the ground up, that retains the deterministic boundary of operation, but exposes a plugin architecture.
|
||||
|
||||
## Track Protocol Conformance
|
||||
* Identify any gaps in V1 inspector
|
||||
* Track which features are covered
|
||||
* Implement to parity and fill gaps
|
||||
* Provide conformance testing in CI
|
||||
|
||||
## Improve Maintainability
|
||||
* Clearer separation of concerns
|
||||
* Smaller, reusable components
|
||||
|
||||
## Provide Extensibility
|
||||
* Plugin SDK / API
|
||||
* Third parties cand develop/maintain their own plugins for features such as
|
||||
* LLM usage
|
||||
* Evals
|
||||
* Multiple server connections
|
||||
* Apps playground
|
||||
* Testing of registry configuration
|
||||
* Interface with registry
|
||||
|
||||
## Proper Documentation
|
||||
* One big README won't cut it anymore
|
||||
* Published documentation in MDX should
|
||||
* Render in style of spec
|
||||
* Kept up to date
|
||||
* Cover all features
|
||||
* Discuss troubleshooting strategies
|
||||
* Provide detailed contribution guidance that explains architecture and expected idioms
|
||||
|
||||
Loading…
Reference in a new issue