Batch Changes Docs Updates for 6.4

.env.baseai.example

@@ -0,0 +1,7 @@
+# !! SERVER SIDE ONLY !!
+# Keep all your API keys secret — use only on the server side.
+
+# TODO: ADD: Both in your production and local env files.
+# Langbase API key for your User or Org account.
+# How to get this API key https://langbase.com/docs/api-reference/api-keys
+LANGBASE_API_KEY=

.github/pull_request_template.md

@@ -0,0 +1,5 @@
+<!-- Explain the changes introduced in your PR -->
+
+## Pull Request approval
+
+You will need to get your PR approved by at least one member of the Sourcegraph team. For reviews of docs formatting, styles, and component usage, please tag the docs team via the #docs Slack channel.

.github/workflows/pr-auditor.yml

@@ -2,19 +2,20 @@ name: pr-auditor
 on:
   pull_request_target:
     types: [ closed, edited, opened, synchronize, ready_for_review ]
-  workflow_dispatch:
+
 
 jobs:
   check-pr:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
         with:
-          repository: 'sourcegraph/pr-auditor'
+          repository: 'sourcegraph/devx-service'
+          token: ${{ secrets.PR_AUDITOR_TOKEN }}
       - uses: actions/setup-go@v4
-        with: { go-version: '1.21' }
+        with: { go-version: '1.22' }
 
-      - run: './check-pr.sh'
+      - run: 'go run ./cmd/pr-auditor'
         env:
           GITHUB_EVENT_PATH: ${{ env.GITHUB_EVENT_PATH }}
           GITHUB_TOKEN: ${{ secrets.PR_AUDITOR_TOKEN }}
@@ -25,5 +26,5 @@ jobs:
   report_failure:
     needs: check-pr
     if: ${{ failure() }}
-    uses: sourcegraph/sourcegraph/.github/workflows/report-job-failure.yml@main
+    uses: sourcegraph/workflows/.github/workflows/report-job-failure.yml@main
     secrets: inherit

.gitignore

@@ -39,3 +39,17 @@ next-env.d.ts
 
 # search index file generated on build
 /public/search.json
+
+# IDEs
+.idea
+
+# We ignore the generated file as it should always be generated
+public/changelog.rss
+
+# baseai
+**/.baseai/
+
+# env file
+.env
+
+public/technical-changelog.rss

README.md

@@ -1,5 +1,7 @@
 # Sourcegraph Docs
 
+<!-- Working branch for SG 6.3 Release -->
+
 Welcome to the Sourcegraph documentation! We're excited to have you contribute to our docs. We've recently rearchitectured our docs tech stack — powered by Next.js, TailwindCSS and deployed on Vercel. This guide will walk you through the process of contributing to our documentation using the new tech stack.
 
 ## Get started
@@ -16,7 +18,7 @@ Navigate to the project directory by typing the following command in your termin
 cd sourcegraph-docs
 ```
 
-Before the dependencies are install make sure your local machine has the following versions of `node` and `pnpm`:
+Before the dependencies are install make sure your local machine has the following versions of `node` and `pnpm` installed:
 
 * node: `v20.8.1`
 * pnpm: `8.13.1`
@@ -84,7 +86,7 @@ This is an introductory paragraph.
 
 ### This is heading 3
 
-These are the details for heading three. 
+These are the details for heading three.
 
 This is how you add a [demo-link](https://sourcegraph.com/)
 
@@ -116,7 +118,7 @@ Here are the list of all the supported components we have:
 - `<LinkCards>`
 - `<Callout>`
 
-For a better docs experience we'll continue adding more components in future.
+For a better docs experience, we'll continue adding more components in the future.
 
 ### Adding a link
 
@@ -132,9 +134,9 @@ For example, if you want to link to the Cody Quickstart somewhere in the Code Se
 - This is a way to hash-link to [Cody for VSCode installation](/cody/clients/install-vscode#verifying-the-installation) in Code Search docs
 ```
 
-### Adding images and binary assets
+### Adding media assets (images, videos and gifs)
 
-For large images and other binary assets, upload them to the `sourcegraph-assets` Google Cloud Storage bucket instead with `gsutil cp -a public-read local/path/to/myasset.png gs://sourcegraph-assets/` (and refer to them as `https://sourcegraphstatic.com/myasset.png`). For a more detailed instructions visit [this page](https://handbook.sourcegraph.com/handbook/editing/handbook-images-video/).
+You can upload images, videos and gifs to Sourcegraph docs. For a more detailed instructions visit [this page](https://www.notion.so/sourcegraph/How-to-host-blog-assets-using-GCP-file-storage-a2cae02bd0c74166a12eaff5062c41ad).
 
 > Note: Make sure to use [ImageOptim.app](https://imageoptim.com/mac) to reduce the size of the images before uploading, since large images degrade page loading speed.
 
@@ -144,6 +146,12 @@ For large images and other binary assets, upload them to the `sourcegraph-assets
 
 As you make changes to the documentation, the development server will automatically update. Review your changes by navigating to `http://localhost:3000` in your browser.
 
+### Previewing Vercel Deployments
+
+When you open a PR Vercel deploys and provides you with a preview deployment link. To view your deployment, click the **Visit Preview** link from Vercel's deployment panel in your PRs and you get a preview of your docs
+
+![CleanShot 2024-11-05 at 10 11 29@2x](https://github.com/user-attachments/assets/b0911e2e-95a7-4f56-b2ff-b659d13077d8)
+
 ## Submitting your Contribution
 
 Once you're satisfied with your changes, follow these steps:

baseai/baseai.config.ts

@@ -0,0 +1,18 @@
+import type { BaseAIConfig } from 'baseai';
+
+export const config: BaseAIConfig = {
+	log: {
+		isEnabled: true,
+		logSensitiveData: false,
+		pipe: true,
+		'pipe.completion': true,
+		'pipe.request': true,
+		'pipe.response': true,
+		tool: true,
+		memory: true
+	},
+	memory: {
+		useLocalEmbeddings: false
+	},
+	envFilePath: '.env'
+};

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

@@ -0,0 +1,27 @@
+import { MemoryI } from '@baseai/core';
+
+const memoryDocs = (): MemoryI => ({
+	name: 'memory-sg-docs-live',
+	description: 'An AI memory storing all Sourcegraph docs.',
+	git: {
+		enabled: true,
+		include: ['**/*.mdx'],
+		gitignore: true,
+		embeddedAt: '',
+		deployedAt: '1b67d5c14520a898e2b9933ab3d2a9fe28515e31'
+	},
+	documents: {
+		meta: doc => {
+			const url = `https://sourcegraph.com/docs/${doc.path}`;
+			return {
+				url,
+				name: doc.name,
+			};
+		},
+	},
+});
+
+export default memoryDocs;
+
+// Old
+// deployedAt: '5f3fec8530280d01a783aadcdeb0ccc3f9cd8b70',

contentlayer.config.ts

@@ -7,6 +7,8 @@ import remarkGfm from 'remark-gfm';
 import { MDXDocument, allCoreContent } from './src/utils/contentlayer';
 import { searchMetadata } from './src/data/search';
 import GithubSlugger from 'github-slugger'
+import { visit } from "unist-util-visit"
+
 export const Post = defineDocumentType(() => ({
     name: 'Post',
     filePathPattern: `**/*.mdx`,
@@ -70,13 +72,39 @@ const prettyCodeOptions = {
     ),
 }
 
+const rehypePlugins:any = [
+  // Extract raw code content from code elements within pre elements
+  () => (tree: any) => {
+    visit(tree, (node: any) => {
+      if (node?.type === "element" && node?.tagName === "pre") {
+        const [codeEl] = node.children;
+        if (codeEl.tagName !== "code") return
+
+        node.raw = codeEl.children?.[0].value
+      }
+    });
+  },
+  [rehypePrettyCode, prettyCodeOptions],
+  // Add raw code content as a property to pre elements within div elements containing data-rehype-pretty-code-fragment attribute
+  () => (tree: any) => {
+    visit(tree, (node: any) => {
+      if (node?.type === "element" && node?.tagName === "div") {
+        if (!("data-rehype-pretty-code-fragment" in node.properties)) return
+
+        for (const child of node.children)
+          if (child.tagName === "pre") child.properties["raw"] = node.raw;
+      }
+    })
+  },rehypeSlug, [rehypeAutolinkHeadings]
+]
+
 export default makeSource({
     contentDirPath: 'docs', documentTypes: [Post], mdx: {
-        remarkPlugins: [remarkGfm],
-        rehypePlugins: [[rehypePrettyCode, prettyCodeOptions], rehypeSlug, [rehypeAutolinkHeadings]],
+      remarkPlugins: [remarkGfm],
+      rehypePlugins: rehypePlugins,
     },
     onSuccess: async (importData) => {
-        const { allPosts } = await importData()
-        createSearchIndex(allPosts);
+      const { allPosts } = await importData()
+      createSearchIndex(allPosts);
     },
 })

dev/rss.js

@@ -0,0 +1,71 @@
+const { Feed } = require('feed');
+const fs = require('fs');
+const path = require('path');
+
+const loadChangelog = () => {
+    const changelogPath = path.join(__dirname, '..', 'docs', 'technical-changelog.mdx');
+    return fs.readFileSync(changelogPath, 'utf8');
+}
+
+const extractRSSComments = (content) => {
+    const regex = /\{\/\*\s*RSS=(.*?)\s*\*\/}/g;
+    const matches = [];
+    let match;
+
+    while ((match = regex.exec(content)) !== null) {
+        matches.push(JSON.parse(match[1].trim()));
+    }
+
+    return matches;
+}
+
+const generateRssFeed = () => {
+    const baseURL = 'https://sourcegraph.com'
+    const siteURL = 'https://sourcegraph.com/docs';
+    const date = new Date();
+
+    const feed = new Feed({
+        title: 'Sourcegraph RSS',
+        description: 'RSS feed for Sourcegraph',
+        id: siteURL,
+        link: baseURL,
+        language: 'en',
+        image: `${siteURL}/sourcegraph-mark.png`,
+        favicon: `${siteURL}/sourcegraph-mark.png`,
+        copyright: `All rights reserved ${date.getFullYear()}, Sourcegraph`,
+        updated: date,
+        generator: 'Sourcegraph RSS Feed',
+        feedLinks: {
+            rss2: `${siteURL}/technical-changelog.rss`,
+        },
+        author: {
+            name: 'Sourcegraph',
+            email: 'hi@sourcegraph.com',
+            link: 'https://sourcegraph.com',
+        },
+    });
+
+    const changelog = loadChangelog();
+    const rssComments = extractRSSComments(changelog);
+
+    // the rss comments have the structure: {/* RSS={"version":"vX.Y.Z", "releasedAt": "<TS>" */}
+    for (let idx = 0; idx < rssComments.length; idx++) {
+        const comment = rssComments[idx];
+        if (!comment.version || !comment.releasedAt) {
+            continue;
+        }
+        const tag = comment.version.replace('v', '');
+        const versionDocLink = `${siteURL}/technical-changelog#${comment.version.replaceAll('.', '')}`;
+        feed.addItem({
+            title: `Sourcegraph ${tag}`,
+            id: comment.version,
+            link: versionDocLink,
+            description: `Sourcegraph ${tag} is now available! Note: we've updated our versioning conventions. Please see our releases page for more information.`,
+            date: new Date(comment.releasedAt),
+        });
+    }
+
+    fs.writeFileSync(path.join(__dirname, '../public/technical-changelog.rss'), feed.rss2());
+}
+
+module.exports = { generateRssFeed }

docs-chatbot.md

@@ -0,0 +1,19 @@
+# How we use Docs Chatbot?
+
+Contact the docs team for any more questions on this.
+
+## To sync all the latest docs changes in the `main` branch check out to the `main` branch and run
+
+```sh
+pnpm langbase-sync
+```
+
+This will verify all the changes since the last sync, update these files, and then write the commit hash to `baseai/memory/docs/index.ts` file which you should commit to keep track.
+
+### Update llms.txt file
+
+Run the following command to update the `llms.txt` file:
+
+```sh
+pnpm llmstxt
+```

docs.config.js

@@ -1,5 +1,5 @@
 const config = {
-	DOCS_LATEST_VERSION: '5.3'
+	DOCS_LATEST_VERSION: '6.3'
 };
 
 module.exports = config;