handbook-introduction
Learn how Turbo's HTML-over-the-wire approach uses Drive, Frames, Streams, and Native to build fast web applications without heavy JavaScript frameworks.
Instructions
Introduction to Turbo - learn about HTML-over-the-wire approach, persistent processes, and how Turbo Drive, Frames, Streams, and Native work together to create fast web applications without heavy JavaScript frameworks
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Implementation Reference
- src/config.ts:14-19 (registration)Configuration entry for the 'handbook-introduction' tool in the docFiles array, providing folder, file path, name, and description used for registration.
{ folder: 'handbook', file: '01_introduction.md', name: 'handbook-introduction', description: 'Introduction to Turbo - learn about HTML-over-the-wire approach, persistent processes, and how Turbo Drive, Frames, Streams, and Native work together to create fast web applications without heavy JavaScript frameworks' }, - src/index.ts:17-45 (registration)Dynamic registration of the 'handbook-introduction' tool (and all doc tools) using server.tool, providing the inline handler function.
docFiles.forEach(({ folder, file, name, description }) => { server.tool( name, description, async () => { try { const content = await readMarkdownFile(path.join(folder, file)); return { content: [ { type: "text", text: content } ] }; } catch (error) { const errorMessage = error instanceof Error ? error.message : String(error); return { content: [ { type: "text", text: `Error reading ${file}: ${errorMessage}` } ] }; } } ); }); - src/documentReader.ts:14-61 (handler)Core handler logic: the readMarkdownFile function that retrieves the markdown content for handbook/01_introduction.md, with caching, GitHub fetch, and local fallback.
export async function readMarkdownFile(filename: string): Promise<string> { const filePath = path.join(docsFolder, filename); if (!filePath.startsWith(docsFolder)) { throw new Error("Invalid file path"); } // Get current commit info if we don't have it yet if (!mainBranchInfo) { try { const commitInfo = await fetchMainBranchInformation(); const cacheKey = `${commitInfo.sha.substring(0, 7)}-${commitInfo.timestamp}`; mainBranchInfo = { ...commitInfo, cacheKey }; } catch (shaError) { console.error('Failed to get GitHub commit info, falling back to direct fetch'); } } // Try to read from cache first if we have commit info if (mainBranchInfo) { const cachedFilePath = path.join(cacheFolder, mainBranchInfo.cacheKey, filename); try { const content = await fs.promises.readFile(cachedFilePath, "utf-8"); console.error(`Using cached content for ${mainBranchInfo.cacheKey}: ${filename}`); return content; } catch (cacheError) { // Cache miss, continue to fetch from GitHub } } // Fetch from GitHub try { return await fetchFromGitHub(filename, mainBranchInfo?.cacheKey); } catch (githubError) { console.error(`GitHub fetch failed: ${githubError}, attempting to read from local files...`); // Fallback: read from local files try { return await fs.promises.readFile(filePath, "utf-8"); } catch (localError) { const githubErrorMessage = githubError instanceof Error ? githubError.message : String(githubError); const localErrorMessage = localError instanceof Error ? localError.message : String(localError); throw new Error(`Failed to read file from GitHub (${githubErrorMessage}) and locally (${localErrorMessage})`); } } }