Skip to content

Commit 5f4a2f2

Browse files
rubenmarcusclaude
andauthored
feat(docs): add FAQPage and HowTo JSON-LD schemas for SEO/AEO (#267)
* feat(docs): add FAQPage and HowTo JSON-LD schemas for SEO Add structured data schemas to improve search engine rich results: - FAQPage with 6 Q&A pairs from existing FAQ content - HowTo for "convert Figma designs to code" workflow - Cross-link GitHub source docs to GitHub wizard Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * fix(docs): remove broken link to non-existent cli/github page The cli/github page does not exist yet — removed the dangling See Also link to fix the docs build. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
1 parent c70987c commit 5f4a2f2

2 files changed

Lines changed: 123 additions & 7 deletions

File tree

docs/docs/sources/github.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -200,3 +200,8 @@ See [`ralph-starter task`](/docs/cli/task) for full details.
200200
1. **Use labels effectively** - Create a "ready-to-build" or "ralph" label for issues that are well-specified
201201
2. **Write detailed issues** - Include requirements, acceptance criteria, and context
202202
3. **One issue = one feature** - Keep issues focused for better results
203+
204+
## See Also
205+
206+
- [run](/docs/cli/run) — The underlying run command with all options
207+
- [auto](/docs/cli/auto) — Batch-process multiple GitHub issues autonomously

docs/docusaurus.config.ts

Lines changed: 118 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ const config: Config = {
4141
tagName: 'meta',
4242
attributes: {
4343
name: 'keywords',
44-
content: 'ralph wiggum, autonomous AI coding, claude code, AI code generation, coding loops, MCP server, developer tools',
44+
content: 'ralph wiggum, autonomous AI coding, claude code, AI code generation, coding loops, MCP server, developer tools, visual validation, Figma to code, pixel comparison, design to code',
4545
},
4646
},
4747
{
@@ -109,7 +109,7 @@ const config: Config = {
109109
'@context': 'https://schema.org',
110110
'@type': 'SoftwareApplication',
111111
name: 'ralph-starter',
112-
description: 'AI-powered autonomous coding tool. Connect GitHub, Linear, Notion and run AI coding loops from specs to production.',
112+
description: 'AI-powered autonomous coding tool. Connect Figma, GitHub, Linear, Notion and run AI coding loops with visual validation from specs to production.',
113113
url: siteUrl,
114114
applicationCategory: 'DeveloperApplication',
115115
operatingSystem: 'macOS, Linux, Windows',
@@ -127,7 +127,7 @@ const config: Config = {
127127
downloadUrl: 'https://www.npmjs.com/package/ralph-starter',
128128
codeRepository: 'https://github.com/multivmlabs/ralph-starter',
129129
programmingLanguage: 'TypeScript',
130-
keywords: ['AI coding', 'autonomous coding', 'claude code', 'MCP server', 'developer tools'],
130+
keywords: ['AI coding', 'autonomous coding', 'claude code', 'MCP server', 'developer tools', 'visual validation', 'Figma to code', 'pixel comparison', 'design to code'],
131131
}),
132132
},
133133
// JSON-LD: Organization schema for stronger search understanding
@@ -177,7 +177,7 @@ const config: Config = {
177177
'@context': 'https://schema.org',
178178
'@type': 'TechArticle',
179179
headline: 'ralph-starter Documentation',
180-
description: 'Complete documentation for ralph-starter - AI-powered autonomous coding tool. Learn how to connect Figma, GitHub, Linear, and Notion to run AI coding loops from specs to production.',
180+
description: 'Complete documentation for ralph-starter - AI-powered autonomous coding tool with visual validation. Learn how to connect Figma, GitHub, Linear, and Notion to run AI coding loops from specs to production.',
181181
url: `${siteUrl}/docs/intro`,
182182
author: {
183183
'@type': 'Person',
@@ -193,7 +193,7 @@ const config: Config = {
193193
articleSection: 'Documentation',
194194
proficiencyLevel: 'Beginner',
195195
dependencies: 'Node.js 18+',
196-
keywords: ['AI coding', 'autonomous coding', 'claude code', 'MCP server', 'Figma integration', 'GitHub integration', 'Linear integration', 'Notion integration'],
196+
keywords: ['AI coding', 'autonomous coding', 'claude code', 'MCP server', 'Figma integration', 'GitHub integration', 'Linear integration', 'Notion integration', 'visual validation', 'pixel comparison', 'Figma wizard', 'design fidelity'],
197197
about: [
198198
{
199199
'@type': 'Thing',
@@ -205,6 +205,117 @@ const config: Config = {
205205
name: 'Developer Tools',
206206
description: 'CLI tools for software development automation',
207207
},
208+
{
209+
'@type': 'Thing',
210+
name: 'Visual Validation',
211+
description: 'Pixel-by-pixel comparison between Figma designs and AI-generated code implementations',
212+
},
213+
],
214+
}),
215+
},
216+
// JSON-LD: FAQPage schema for rich FAQ snippets
217+
{
218+
tagName: 'script',
219+
attributes: {
220+
type: 'application/ld+json',
221+
},
222+
innerHTML: JSON.stringify({
223+
'@context': 'https://schema.org',
224+
'@type': 'FAQPage',
225+
mainEntity: [
226+
{
227+
'@type': 'Question',
228+
name: 'What is ralph-starter?',
229+
acceptedAnswer: {
230+
'@type': 'Answer',
231+
text: 'ralph-starter is a CLI tool that runs autonomous AI coding loops. Give it a task or specification, and it will build production-ready code automatically using Claude Code or other AI coding agents.',
232+
},
233+
},
234+
{
235+
'@type': 'Question',
236+
name: 'Is ralph-starter free?',
237+
acceptedAnswer: {
238+
'@type': 'Answer',
239+
text: 'ralph-starter is open source and free to use. Costs come from the AI agent you choose — typically $0.10 to $1.00 per feature depending on complexity and model.',
240+
},
241+
},
242+
{
243+
'@type': 'Question',
244+
name: 'Can ralph-starter convert Figma designs to code?',
245+
acceptedAnswer: {
246+
'@type': 'Answer',
247+
text: 'Yes. ralph-starter has a dedicated Figma wizard (ralph-starter figma) that converts Figma designs to production-ready code with three-layer visual validation achieving 98%+ pixel match accuracy.',
248+
},
249+
},
250+
{
251+
'@type': 'Question',
252+
name: 'Which AI coding agents does ralph-starter support?',
253+
acceptedAnswer: {
254+
'@type': 'Answer',
255+
text: 'ralph-starter supports Claude Code, Cursor, OpenAI Codex, Gemini CLI, GitHub Copilot, OpenCode, Amp, and Openclaw. It auto-detects which agents are installed and lets you choose the model.',
256+
},
257+
},
258+
{
259+
'@type': 'Question',
260+
name: 'What integrations does ralph-starter support?',
261+
acceptedAnswer: {
262+
'@type': 'Answer',
263+
text: 'ralph-starter integrates with Figma (design specs and visual validation), GitHub (issues and PRs), Linear (tickets and projects), and Notion (pages and databases). It can also read from URLs, PDFs, and local files.',
264+
},
265+
},
266+
{
267+
'@type': 'Question',
268+
name: 'Do I need to be a developer to use ralph-starter?',
269+
acceptedAnswer: {
270+
'@type': 'Answer',
271+
text: 'No. ralph-starter includes an interactive wizard that guides anyone through creating projects. Just run ralph-starter with no arguments and follow the prompts.',
272+
},
273+
},
274+
],
275+
}),
276+
},
277+
// JSON-LD: HowTo schema for Figma-to-code workflow
278+
{
279+
tagName: 'script',
280+
attributes: {
281+
type: 'application/ld+json',
282+
},
283+
innerHTML: JSON.stringify({
284+
'@context': 'https://schema.org',
285+
'@type': 'HowTo',
286+
name: 'How to convert Figma designs to code with AI',
287+
description: 'Use ralph-starter to automatically generate production-ready code from Figma designs with pixel-by-pixel visual validation.',
288+
totalTime: 'PT5M',
289+
tool: {
290+
'@type': 'SoftwareApplication',
291+
name: 'ralph-starter',
292+
url: siteUrl,
293+
},
294+
step: [
295+
{
296+
'@type': 'HowToStep',
297+
position: 1,
298+
name: 'Install ralph-starter',
299+
text: 'Run npm install -g ralph-starter to install globally, or use npx ralph-starter for one-time use.',
300+
},
301+
{
302+
'@type': 'HowToStep',
303+
position: 2,
304+
name: 'Run the Figma wizard',
305+
text: 'Run ralph-starter figma and paste your Figma design URL when prompted.',
306+
},
307+
{
308+
'@type': 'HowToStep',
309+
position: 3,
310+
name: 'Describe what to build',
311+
text: 'Describe the component or page in natural language. ralph-starter auto-detects your tech stack from package.json.',
312+
},
313+
{
314+
'@type': 'HowToStep',
315+
position: 4,
316+
name: 'Get pixel-perfect code',
317+
text: 'ralph-starter generates code, runs visual validation comparing against the Figma design, fixes mismatches, and commits the result.',
318+
},
208319
],
209320
}),
210321
},
@@ -272,10 +383,10 @@ const config: Config = {
272383
{ property: 'og:type', content: 'website' },
273384
{ property: 'og:site_name', content: 'ralph-starter' },
274385
{ property: 'og:title', content: 'ralph-starter - AI-Powered Autonomous Coding' },
275-
{ property: 'og:description', content: 'Connect your tools like GitHub, Linear, and Notion. Fetch specs from anywhere and let AI coding agents build production-ready code automatically.' },
386+
{ property: 'og:description', content: 'Connect Figma, GitHub, Linear, and Notion. Run AI coding loops with visual validation — pixel-perfect code from design to production.' },
276387
{ property: 'og:image', content: `${siteUrl}/img/thumbnail.png` },
277388
{ name: 'twitter:title', content: 'ralph-starter - AI-Powered Autonomous Coding' },
278-
{ name: 'twitter:description', content: 'Connect your tools like GitHub, Linear, and Notion. Fetch specs from anywhere and let AI coding agents build production-ready code automatically.' },
389+
{ name: 'twitter:description', content: 'Connect Figma, GitHub, Linear, and Notion. Run AI coding loops with visual validation — pixel-perfect code from design to production.' },
279390
{ name: 'twitter:image', content: `${siteUrl}/img/thumbnail.png` },
280391
{ name: 'twitter:site', content: '@ralphstarter' },
281392
],

0 commit comments

Comments
 (0)