Skip to content

Making some QUICK updates to the docs (oops!) #340

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.

Sign up for GitHub

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

Merged
torimwhaley merged 6 commits into from
Jan 14, 2026
Merged

Making some QUICK updates to the docs (oops!) #340

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
cb1dccb
Making some QUICK updates to the docs (oops!)
torimwhaley Jan 14, 2026
bf89d38
script comment update
torimwhaley Jan 14, 2026
df41482
fix
torimwhaley Jan 14, 2026
5d3b549
fix
torimwhaley Jan 14, 2026
86d782f
better commenting
torimwhaley Jan 14, 2026
5452956
Merge branch 'main' into friday-demos
torimwhaley Jan 14, 2026
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
2 changes: 1 addition & 1 deletion scripts/check-image-locations.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ function findMDXFiles(dir, fileList = []) {
function extractImageReferences(content, filePath) {
const images = [];

// Remove code blocks to avoid flagging example images
// Remove code blocks to avoid flagging example images in documentation
const contentWithoutCodeBlocks = removeCodeBlocks(content);

// Extract markdown images: ![alt](path)
Expand Down
7 changes: 3 additions & 4 deletions scripts/check-links.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,11 @@ const CHECK_EXTERNAL = process.argv.includes('--external');

// Regex patterns for finding links
const MARKDOWN_LINK_REGEX = /\[([^\]]+)\]\(([^)]+)\)/g;
const JSX_LINK_REGEX = /(?:href|src)=["']([^"']+)["']/g;
const JSX_LINK_REGEX = /href=["']([^"']+)["']/g;
const ANCHOR_REGEX = /#[^)\s"']*/;
const CODE_BLOCK_REGEX = /```[\s\S]*?```/g;

function removeCodeBlocks(content) {
// Replace code blocks with same number of newlines to preserve line numbers
return content.replace(CODE_BLOCK_REGEX, (match) => {
const newlineCount = (match.match(/\n/g) || []).length;
return '\n'.repeat(newlineCount);
Expand All @@ -45,7 +44,7 @@ function findMDXFiles(dir, fileList = []) {
function extractLinks(content, filePath) {
const links = [];

// Remove code blocks to avoid flagging example links
// Remove code blocks to avoid flagging example links in documentation
const contentWithoutCodeBlocks = removeCodeBlocks(content);

// Extract markdown links: [text](url)
Expand All @@ -59,7 +58,7 @@ function extractLinks(content, filePath) {
});
}

// Extract JSX links: href="..." or src="..."
// Extract JSX links: href="..."
while ((match = JSX_LINK_REGEX.exec(contentWithoutCodeBlocks)) !== null) {
links.push({
url: match[1],
Expand Down