Skip to content

docs: conversation-based agents #387

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,14 @@ Monorepo
- [server-interface/](runtimes/server-interface) - server type definition to create language servers
- [types/](types) - type definitions for the runtimes

## Artifacts

This repo produces these NPM packages:

- https://www.npmjs.com/package/@aws/chat-client-ui-types
- https://www.npmjs.com/package/@aws/language-server-runtimes
- https://www.npmjs.com/package/@aws/language-server-runtimes-types

## Contributing

- [How to contribute](CONTRIBUTING.md#contributing)
Expand Down
1 change: 1 addition & 0 deletions types/chat.ts
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,7 @@ export interface QuickActions {

export interface TabData {
placeholderText?: string
/** New or updated messages (depending on `messageId`). */
messages: ChatMessage[]
}

Expand Down
3 changes: 3 additions & 0 deletions types/workspace.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import { URI, TextDocument } from './lsp'

/** Server to client. Used to ask the user to select a folder, if the workspace folder is too big */
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Server to client" is specified in README - I would prefer to keep it there, specifying the direction of request in one place only looks inconsistent to me.
"if the workspace folder is too big" - this is just one of examples when it will be used, I do not think we need it in comment like this.
"select a folder" -> "select files(s) or folder(s)"

export const SELECT_WORKSPACE_ITEM_REQUEST_METHOD = 'aws/selectWorkspaceItem'
export const OPEN_FILE_DIFF_NOTIFICATION_METHOD = 'aws/openFileDiff'

Expand All @@ -18,7 +19,9 @@ export interface SelectWorkspaceItemResult {
}

export interface OpenFileDiffParams {
/** The initial version of the file. */
originalFileUri: URI
/** Indicates if the original file was deleted and fileContent contains the new/updated file contents. */
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we please spilt it into 2 comments for 2 fields?

isDeleted: boolean
fileContent?: string
}
Loading