Skip to content

fix: readme for vercel #86

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
liady merged 1 commit into from
Apr 14, 2025
Merged

fix: readme for vercel #86

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 16 additions & 2 deletions src/api/tools/commonTools.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -216,11 +216,13 @@ export async function fetchDocumentation({
console.log(`llms.txt not found, trying README.md`);
// Only use static approach for README, no search API
// Try main branch first
const readmeLocation = getReadmeMDLocationByRepoData(repoData);

content = await fetchFileFromGitHub(
owner,
repo,
"main",
"README.md",
readmeLocation,
env,
false,
);
Expand All @@ -232,7 +234,7 @@ export async function fetchDocumentation({
owner,
repo,
"master",
"README.md",
readmeLocation,
env,
);
fileUsed = "readme.md (master branch)";
Expand Down Expand Up @@ -885,3 +887,15 @@ export function generateCodeSearchToolDescription({
return "Search code in the current repository.";
}
}

const readmeMdLocations: Record<string, `${string}/${string}`> = {
"vercel/next.js": "packages/next/README.md",
};
function getReadmeMDLocationByRepoData(repoData: RepoData): string {
if (!repoData.owner || !repoData.repo) {
return "README.md";
}
const readmeLocation =
readmeMdLocations[`${repoData.owner}/${repoData.repo}`];
return readmeLocation ?? "README.md";
}