diff options
| author | Nate Sesti <sestinj@gmail.com> | 2023-09-12 01:16:41 -0700 |
|---|---|---|
| committer | Nate Sesti <sestinj@gmail.com> | 2023-09-12 01:16:41 -0700 |
| commit | db3277bdc207cc8233ccc4c1d44a5c8e50785769 (patch) | |
| tree | d0197d581bc89ffa3f19c407729c9ccf2f39e9fd /docs | |
| parent | 84fc39407648131d54a8ed5c95891906afc3cd60 (diff) | |
| download | sncontinue-db3277bdc207cc8233ccc4c1d44a5c8e50785769.tar.gz sncontinue-db3277bdc207cc8233ccc4c1d44a5c8e50785769.tar.bz2 sncontinue-db3277bdc207cc8233ccc4c1d44a5c8e50785769.zip | |
docs: :memo: additional cleanup for context providers docs
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/docs/reference/Context Providers/diff.md | 2 | ||||
| -rw-r--r-- | docs/docs/reference/Context Providers/filetree.md | 2 | ||||
| -rw-r--r-- | docs/docs/reference/Context Providers/github.md | 2 | ||||
| -rw-r--r-- | docs/docs/reference/Context Providers/google.md | 2 | ||||
| -rw-r--r-- | docs/docs/reference/Context Providers/search.md | 2 | ||||
| -rw-r--r-- | docs/docs/reference/Context Providers/terminal.md | 2 | ||||
| -rw-r--r-- | docs/docs/reference/Context Providers/url.md | 2 |
7 files changed, 7 insertions, 7 deletions
diff --git a/docs/docs/reference/Context Providers/diff.md b/docs/docs/reference/Context Providers/diff.md index 00d63d58..2b809b91 100644 --- a/docs/docs/reference/Context Providers/diff.md +++ b/docs/docs/reference/Context Providers/diff.md @@ -8,7 +8,7 @@ Type '@diff' to reference all of the changes you've made to your current branch. ## Properties -<ClassPropertyRef name='workspace_dir' details='{"title": "Workspace Dir", "type": "string"}' required={false} default=""/><ClassPropertyRef name='DIFF_CONTEXT_ITEM_ID' details='{"title": "Diff Context Item Id", "default": "diff", "type": "string"}' required={false} default="diff"/> +<ClassPropertyRef name='workspace_dir' details='{"title": "Workspace Dir", "description": "The workspace directory in which to run `git diff`", "type": "string"}' required={false} default=""/> ### Inherited Properties diff --git a/docs/docs/reference/Context Providers/filetree.md b/docs/docs/reference/Context Providers/filetree.md index 94492d3d..8af3ba03 100644 --- a/docs/docs/reference/Context Providers/filetree.md +++ b/docs/docs/reference/Context Providers/filetree.md @@ -8,7 +8,7 @@ Type '@tree' to reference the contents of your current workspace. The LLM will b ## Properties -<ClassPropertyRef name='workspace_dir' details='{"title": "Workspace Dir", "type": "string"}' required={false} default=""/> +<ClassPropertyRef name='workspace_dir' details='{"title": "Workspace Dir", "description": "The workspace directory to display", "type": "string"}' required={false} default=""/> ### Inherited Properties diff --git a/docs/docs/reference/Context Providers/github.md b/docs/docs/reference/Context Providers/github.md index 21171ced..bd1f7cc3 100644 --- a/docs/docs/reference/Context Providers/github.md +++ b/docs/docs/reference/Context Providers/github.md @@ -8,7 +8,7 @@ The GitHubIssuesContextProvider is a ContextProvider that allows you to search G ## Properties -<ClassPropertyRef name='repo_name' details='{"title": "Repo Name", "type": "string"}' required={true} default=""/><ClassPropertyRef name='auth_token' details='{"title": "Auth Token", "type": "string"}' required={true} default=""/> +<ClassPropertyRef name='repo_name' details='{"title": "Repo Name", "description": "The name of the GitHub repo from which to pull issues", "type": "string"}' required={true} default=""/><ClassPropertyRef name='auth_token' details='{"title": "Auth Token", "description": "The GitHub auth token to use to authenticate with the GitHub API", "type": "string"}' required={true} default=""/> ### Inherited Properties diff --git a/docs/docs/reference/Context Providers/google.md b/docs/docs/reference/Context Providers/google.md index d8452ab0..e5586982 100644 --- a/docs/docs/reference/Context Providers/google.md +++ b/docs/docs/reference/Context Providers/google.md @@ -8,7 +8,7 @@ Type '@google' to reference the results of a Google search. For example, type "@ ## Properties -<ClassPropertyRef name='serper_api_key' details='{"title": "Serper Api Key", "type": "string"}' required={true} default=""/><ClassPropertyRef name='GOOGLE_CONTEXT_ITEM_ID' details='{"title": "Google Context Item Id", "default": "google_search", "type": "string"}' required={false} default="google_search"/> +<ClassPropertyRef name='serper_api_key' details='{"title": "Serper Api Key", "description": "Your SerpAPI key, used to programmatically make Google searches. You can get a key at https://serper.dev.", "type": "string"}' required={true} default=""/> ### Inherited Properties diff --git a/docs/docs/reference/Context Providers/search.md b/docs/docs/reference/Context Providers/search.md index 5d80f607..efc82131 100644 --- a/docs/docs/reference/Context Providers/search.md +++ b/docs/docs/reference/Context Providers/search.md @@ -8,7 +8,7 @@ Type '@search' to reference the results of codebase search, just like the result ## Properties -<ClassPropertyRef name='workspace_dir' details='{"title": "Workspace Dir", "type": "string"}' required={false} default=""/><ClassPropertyRef name='SEARCH_CONTEXT_ITEM_ID' details='{"title": "Search Context Item Id", "default": "search", "type": "string"}' required={false} default="search"/> +<ClassPropertyRef name='workspace_dir' details='{"title": "Workspace Dir", "description": "The workspace directory to search", "type": "string"}' required={false} default=""/> ### Inherited Properties diff --git a/docs/docs/reference/Context Providers/terminal.md b/docs/docs/reference/Context Providers/terminal.md index dce6f0a4..f97d2bf8 100644 --- a/docs/docs/reference/Context Providers/terminal.md +++ b/docs/docs/reference/Context Providers/terminal.md @@ -8,7 +8,7 @@ Type '@terminal' to reference the contents of your IDE's terminal. ## Properties -<ClassPropertyRef name='workspace_dir' details='{"title": "Workspace Dir", "type": "string"}' required={false} default=""/><ClassPropertyRef name='get_last_n_commands' details='{"title": "Get Last N Commands", "default": 3, "type": "integer"}' required={false} default="3"/> +<ClassPropertyRef name='get_last_n_commands' details='{"title": "Get Last N Commands", "description": "The number of previous commands to reference", "default": 3, "type": "integer"}' required={false} default="3"/> ### Inherited Properties diff --git a/docs/docs/reference/Context Providers/url.md b/docs/docs/reference/Context Providers/url.md index 3917dc38..e147e626 100644 --- a/docs/docs/reference/Context Providers/url.md +++ b/docs/docs/reference/Context Providers/url.md @@ -8,7 +8,7 @@ Type '@url' to reference the contents of a URL. You can either reference preset ## Properties -<ClassPropertyRef name='preset_urls' details='{"title": "Preset Urls", "default": [], "type": "array", "items": {"type": "string"}}' required={false} default="[]"/><ClassPropertyRef name='static_url_context_items' details='{"title": "Static Url Context Items", "default": [], "type": "array", "items": {"$ref": "#/definitions/ContextItem"}}' required={false} default="[]"/><ClassPropertyRef name='DYNAMIC_URL_CONTEXT_ITEM_ID' details='{"title": "Dynamic Url Context Item Id", "default": "url", "type": "string"}' required={false} default="url"/> +<ClassPropertyRef name='preset_urls' details='{"title": "Preset Urls", "description": "A list of preset URLs that you will be able to quickly reference by typing '@url'", "default": [], "type": "array", "items": {"type": "string"}}' required={false} default="[]"/> ### Inherited Properties |