Skip to content

Commit

Permalink
📖 Update 01-configuration_and_runtime_support.md (#283)
Browse files Browse the repository at this point in the history
Small typo updates

Signed-off-by: John Matthews <[email protected]>
  • Loading branch information
jwmatthews authored Jan 27, 2025
1 parent d580e45 commit 6f6d870
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions docs/roadmap/stories/01-configuration_and_runtime_support.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Configuration and runtime support

## Story highlights
- Configuration of the analysis/Kia runtime can be on User or Workspace level
- Configuration of the analysis/Kai runtime can be on User or Workspace level

- Select the runtime to setup and configure, options should support:
- deployed with the extension itself _(as the default)_
Expand All @@ -10,16 +10,16 @@

- Configure the runtime server
- Standard configuration view pattern is ok
- Support storing secretes needed by the runtime
- Support logging in to services (e.g. login to LLM proxy)
- Support storing secrets needed by the runtime
- Support logging into services (e.g. login to LLM proxy)
- Support storing already known / manually generated API keys
- __Concern__: In a large corporate environment, developers are unlikely to have keys to directly access a model or even understand what a model is. A guided login to some kind of llm provider at a known URL is preferred.

- Verification of configuration covered under the [startup and keep alive](./02-manage_runtime.md) story

- Use [Walkthroughs](https://code.visualstudio.com/api/ux-guidelines/walkthroughs) as a root for configuration user flows

- After initial install / start of the extension,open the walkthrough to make it obvious that initial configurations need to be chosen and verified before the extension can operate properly.
- After initial install / start of the extension, open the walkthrough to make it obvious that initial configurations need to be chosen and verified before the extension can operate properly.


## Walkthrough for configuration points
Expand Down

0 comments on commit 6f6d870

Please sign in to comment.