Skip to content

Commit 22213f3

Browse files
committed
Run prettier to actually apply the desired config
1 parent 5350570 commit 22213f3

File tree

595 files changed

+43835
-34397
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

595 files changed

+43835
-34397
lines changed

.eslintrc.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
2-
"extends": "next/core-web-vitals",
3-
"rules": {
4-
"react/no-unescaped-entities": "off"
5-
}
2+
"extends": "next/core-web-vitals",
3+
"rules": {
4+
"react/no-unescaped-entities": "off"
5+
}
66
}

AGENTS.md

Lines changed: 30 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -2,53 +2,54 @@
22

33
## Build Commands
44

5-
- **Type Check**: `npx tsc --noEmit`
6-
- **Build**: `npm run build`
7-
- **Dev**: `npm run dev`
8-
- **Lint**: `npm run lint`
5+
- **Type Check**: `npx tsc --noEmit`
6+
- **Build**: `npm run build`
7+
- **Dev**: `npm run dev`
8+
- **Lint**: `npm run lint`
99

1010
## AI Chat Integration
1111

1212
This site uses **runLLM** for the AI chat widget. The integration is implemented via:
1313

14-
- **Location**: `src/app/layout.tsx`
15-
- **Widget**: runLLM script loaded via Next.js `<Script>` component
16-
- **Configuration**:
17-
- Position: BOTTOM_RIGHT
18-
- Theme color: #FF5543 (Sourcegraph brand color)
19-
- Button text: "Ask AI"
20-
- Keyboard shortcut: Mod+j
14+
- **Location**: `src/app/layout.tsx`
15+
- **Widget**: runLLM script loaded via Next.js `<Script>` component
16+
- **Configuration**:
17+
- Position: BOTTOM_RIGHT
18+
- Theme color: #FF5543 (Sourcegraph brand color)
19+
- Button text: "Ask AI"
20+
- Keyboard shortcut: Mod+j
2121

2222
### runLLM Configuration
2323

2424
To update the runLLM assistant ID or other settings, modify the Script component in `src/app/layout.tsx`:
2525

2626
```tsx
2727
<Script
28-
id="runllm-widget-script"
29-
type="module"
30-
src="https://widget.runllm.com"
31-
crossOrigin=""
32-
runllm-keyboard-shortcut="Mod+j"
33-
runllm-name="Sourcegraph AI Assistant"
34-
runllm-position="BOTTOM_RIGHT"
35-
runllm-assistant-id="YOUR_ASSISTANT_ID" // Update this
36-
runllm-theme-color="#FF5543"
37-
runllm-floating-button-text="Ask AI"
38-
async
28+
id="runllm-widget-script"
29+
type="module"
30+
src="https://widget.runllm.com"
31+
crossOrigin=""
32+
runllm-keyboard-shortcut="Mod+j"
33+
runllm-name="Sourcegraph AI Assistant"
34+
runllm-position="BOTTOM_RIGHT"
35+
runllm-assistant-id="YOUR_ASSISTANT_ID" // Update this
36+
runllm-theme-color="#FF5543"
37+
runllm-floating-button-text="Ask AI"
38+
async
3939
/>
4040
```
4141

4242
### Previous Integration
4343

4444
Previously used **Langbase** with custom React components. This has been completely removed:
45-
- Removed `@langbase/components` and `langbase` packages
46-
- Removed custom chat components (`src/app/chat.tsx`, `src/components/ChatBot/`)
47-
- Removed API routes (`src/app/api/chat/`)
48-
- Removed memory creation scripts
45+
46+
- Removed `@langbase/components` and `langbase` packages
47+
- Removed custom chat components (`src/app/chat.tsx`, `src/components/ChatBot/`)
48+
- Removed API routes (`src/app/api/chat/`)
49+
- Removed memory creation scripts
4950

5051
## Important Notes
5152

52-
- **Assistant ID**: The `runllm-assistant-id` is currently set to "YOUR_ASSISTANT_ID" and needs to be updated with the actual Sourcegraph runLLM assistant ID
53-
- **Deployment**: After updating the assistant ID, add the deployment URL to the runLLM dashboard
54-
- **Styling**: The widget inherits the site's theme and uses the Sourcegraph brand color (#FF5543)
53+
- **Assistant ID**: The `runllm-assistant-id` is currently set to "YOUR_ASSISTANT_ID" and needs to be updated with the actual Sourcegraph runLLM assistant ID
54+
- **Deployment**: After updating the assistant ID, add the deployment URL to the runLLM dashboard
55+
- **Styling**: The widget inherits the site's theme and uses the Sourcegraph brand color (#FF5543)

README.md

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ cd docs
2222

2323
Before the dependencies are installed make sure your local machine has the following versions of `node` and `pnpm` installed:
2424

25-
* node: `v20.8.1`
26-
* pnpm: `8.13.1`
25+
- node: `v20.8.1`
26+
- pnpm: `8.13.1`
2727

2828
**Note**: If you have `mise` available you can install the above versions for only this repository by running the following command from your terminal in the root folder:
2929

@@ -48,6 +48,7 @@ Finally, open [`http://localhost:3000`](http://localhost:3000) in your browser t
4848
## Writing and contributing to Sourcegraph Docs
4949

5050
### (Easy) Using GitHub to edit existing files
51+
5152
You can easily update existing docs pages using [GitHub's file editor](https://docs.github.com/en/repositories/working-with-files/managing-files/editing-files). All you need to do is:
5253

5354
1. Find the corresponding `.mdx` file in the [folder structure](#folder-structure).
@@ -58,9 +59,10 @@ You can easily update existing docs pages using [GitHub's file editor](https://d
5859
6. Click on the green "Propose changes" button to create a PR.
5960
7. Add a PR reviewer to the Reviewers panel by clicking on the gear icon.
6061
8. Tag `@maedahbatool` in the `#docs` Slack channel and link to your PR to get a quick review.
61-
> NOTE: "Edit from GitHub" is generally recommended for text-based edits. For more structural-based contributions like adding React components and code blocks, it's always better to go with a local setup. This way, you can preview changes before you commit.
62+
> NOTE: "Edit from GitHub" is generally recommended for text-based edits. For more structural-based contributions like adding React components and code blocks, it's always better to go with a local setup. This way, you can preview changes before you commit.
6263
6364
### (Advanced) Local dev environment
65+
6466
To add new or update existing docs content. Create a new branch and checkout by via:
6567

6668
```sh
@@ -71,8 +73,8 @@ git switch -c BRANCH_NAME_HERE
7173

7274
The folder structure is exactly the same here. All the docs reside within the `/docs` folder. Here you'll find separate folders for every docs section like `cody`, `code_search`, `cli`, etc.
7375

74-
- Navigate to the relevant relevant section for your contribution
75-
- If you're adding a new page, create a new MDX file (e.g., `my-new-page.mdx`) in the appropriate folder
76+
- Navigate to the relevant relevant section for your contribution
77+
- If you're adding a new page, create a new MDX file (e.g., `my-new-page.mdx`) in the appropriate folder
7678

7779
### Using MDX
7880

@@ -115,25 +117,25 @@ This snippet creates a single `<QuickLink>` titled as "Get Cody". You can add as
115117

116118
Here are the list of all the supported components we have:
117119

118-
- `<QuickLinks>`
119-
- `<ProductLinks>`
120-
- `<LinkCards>`
121-
- `<Callout>`
120+
- `<QuickLinks>`
121+
- `<ProductLinks>`
122+
- `<LinkCards>`
123+
- `<Callout>`
122124

123125
For a better docs experience, we'll continue adding more components in the future.
124126

125127
### Adding a link
126128

127129
To add a `link` to any docs page, use the following routing syntax: `[Link text](path-to-link)`.
128130

129-
- Do not include `/docs` in the link paths. The base URL will be `sourcegraph.com/docs`
130-
- There should be **no file extension** in the path name
131+
- Do not include `/docs` in the link paths. The base URL will be `sourcegraph.com/docs`
132+
- There should be **no file extension** in the path name
131133

132134
For example, if you want to link to the Cody Quickstart somewhere in the Code Search docs, you should use:
133135

134136
```markdown
135-
- This is a link to [Cody Quickstart](/cody/quickstart) in Code Search docs
136-
- This is a way to hash-link to [Cody for VSCode installation](/cody/clients/install-vscode#verifying-the-installation) in Code Search docs
137+
- This is a link to [Cody Quickstart](/cody/quickstart) in Code Search docs
138+
- This is a way to hash-link to [Cody for VSCode installation](/cody/clients/install-vscode#verifying-the-installation) in Code Search docs
137139
```
138140

139141
### Adding media assets (images, videos and gifs)
@@ -158,8 +160,8 @@ When you open a PR Vercel deploys and provides you with a preview deployment lin
158160

159161
Once you're satisfied with your changes, follow these steps:
160162

161-
- Commit your changes
162-
- Create a pull request to the [Sourcegraph documentation repository](https://github.com/sourcegraph/docs).
163-
- Tag `@maedahbatool` in `#docs` channel through Slack to get a quick review
163+
- Commit your changes
164+
- Create a pull request to the [Sourcegraph documentation repository](https://github.com/sourcegraph/docs).
165+
- Tag `@maedahbatool` in `#docs` channel through Slack to get a quick review
164166

165167
Thank you for contributing to Sourcegraph documentation! Your efforts help us provide top-notch learning experiences for our users. If you have any questions or need assistance, feel free to reach out.

baseai/baseai.config.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import type { BaseAIConfig } from 'baseai';
1+
import type {BaseAIConfig} from 'baseai';
22

33
export const config: BaseAIConfig = {
44
log: {

baseai/memory/memory-sg-docs-live/index.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import { MemoryI } from '@baseai/core';
1+
import {MemoryI} from '@baseai/core';
22

33
const memoryDocs = (): MemoryI => ({
44
name: 'memory-sg-docs-live',
@@ -15,10 +15,10 @@ const memoryDocs = (): MemoryI => ({
1515
const url = `https://sourcegraph.com/docs/${doc.path}`;
1616
return {
1717
url,
18-
name: doc.name,
18+
name: doc.name
1919
};
20-
},
21-
},
20+
}
21+
}
2222
});
2323

2424
export default memoryDocs;

components.json

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
{
2-
"$schema": "https://ui.shadcn.com/schema.json",
3-
"style": "default",
4-
"rsc": true,
5-
"tsx": true,
6-
"tailwind": {
7-
"config": "tailwind.config.ts",
8-
"css": "src/styles/tailwind.css",
9-
"baseColor": "zinc",
10-
"cssVariables": true,
11-
"prefix": ""
12-
},
13-
"aliases": {
14-
"components": "@/components",
15-
"utils": "@/lib/utils"
16-
}
17-
}
2+
"$schema": "https://ui.shadcn.com/schema.json",
3+
"style": "default",
4+
"rsc": true,
5+
"tsx": true,
6+
"tailwind": {
7+
"config": "tailwind.config.ts",
8+
"css": "src/styles/tailwind.css",
9+
"baseColor": "zinc",
10+
"cssVariables": true,
11+
"prefix": ""
12+
},
13+
"aliases": {
14+
"components": "@/components",
15+
"utils": "@/lib/utils"
16+
}
17+
}

0 commit comments

Comments
 (0)