| name | website-audit |
| description | Audits a website for SEO, AI search performance, structured data, mobile usability, broken links, and social media cards. Fixes issues found. Use when the user mentions "audit website", "SEO", "fix search ranking", "AI search", "structured data", "social media cards", or "website performance". |
Website Audit
Performs a comprehensive website audit and fixes issues affecting search visibility and AI discoverability.
Copy this checklist and track your progress:
Audit Progress:
- [ ] Step 1: Read guidelines
- [ ] Step 2: Audit AI search readiness
- [ ] Step 3: Audit SEO and keywords
- [ ] Step 4: Audit crawling and indexing
- [ ] Step 5: Audit broken links and canonicalization
- [ ] Step 6: Audit mobile usability
- [ ] Step 7: Audit structured data
- [ ] Step 8: Audit social media cards
- [ ] Step 9: Audit For Unsubstantiated Claims
- [ ] Step 10: Audit Design Compliance
- [ ] Step 11: Test with Playwright
- [ ] Step 12: Report findings
- Check the outputted HTML/CSS/JavaScript AFTER the website is generated by the static content generator.
- Don't just check the static content before the website is generated.
- Fix issues at the core where the static content templates are stored - not in the outputted HTML (e.g.
website/_site/)
- Never manually edit the generated website content directly
The SharpLsp website is in website/ and uses Eleventy as the static site generator. Brand color: #19d078 (green).
Step 1 — Read guidelines
Fetch and read each of these before auditing. These are the authoritative references for every step that follows.
If the repo has a business plan doc, take it into account.
Identify the website source files in the repo. The framework is Eleventy — templates, metadata, and content live in website/.
Step 2 — Audit AI search readiness
Apply the guidance from the AI search article. Check:
- Content quality — Is content original, expert-level, and comprehensive? Flag thin or duplicated pages.
- Clear structure — Do pages use descriptive headings, lists, and concise answers to likely questions?
- Entity clarity — Are key terms, products, and concepts defined clearly so AI can extract them? (e.g., "SharpLsp" as an open-source .NET LSP, "sidecar" as the Roslyn/FCS process)
- Freshness signals — Are dates, update timestamps, and authorship present?
Fix issues directly in the source files. For each fix, note what changed and why.
Step 3 — Audit SEO and keywords
- Search Google Trends for trending keywords related to ".NET LSP", "C# language server", "F# development", "VS Code C# extension", "open source .NET IDE".
- Review each page's
<title>, <meta name="description">, and <h1> tags.
- Check for keyword opportunities — can trending terms be naturally inserted into headings, descriptions, or body content?
- Verify each page has a unique, descriptive title (50-60 chars) and meta description (150-160 chars).
- Check image
alt attributes describe the image content and include relevant keywords where natural.
Apply the SEO Starter Guide principles. Fix issues directly.
Step 4 — Audit crawling and indexing
Reference: Overview of crawling and indexing topics
- robots.txt — Locate and review it. Verify it doesn't block important pages. Reference: robots.txt spec
- Sitemap — Locate the sitemap (or sitemap index). Verify all important pages are listed and no dead URLs are included. Reference: Sitemap guidelines
- Meta robots tags — Check for unintended
noindex or nofollow directives on pages that should be indexed.
Note: robots.txt and sitemaps may be auto-generated by Eleventy plugins. If so, check the generator config rather than the output file.
Step 5 — Audit broken links and canonicalization
Reference: What is canonicalization
- Check all internal links resolve to valid pages (no 404s).
- Verify
<link rel="canonical"> tags are present and point to the correct URL.
- Check for duplicate content accessible via multiple URLs (with/without trailing slash, www vs non-www).
- Verify redirects use 301 (permanent) not 302 (temporary) where appropriate.
Step 6 — Audit mobile usability
Reference: Mobile-first indexing best practices
- Verify the
<meta name="viewport"> tag is present and correctly configured.
- Check that content is identical between mobile and desktop (mobile-first indexing requires this).
- Verify touch targets are adequately sized (min 48x48px).
- Check font sizes are readable without zooming (min 16px body text).
Step 7 — Audit structured data
Reference: Structured data guidelines
- Check for existing JSON-LD
<script type="application/ld+json"> blocks.
- Verify the structured data matches the page content (no misleading markup).
- Add missing structured data where appropriate:
- Organization on the homepage (SharpLsp as an open-source project)
- SoftwareApplication for the LSP server
- BreadcrumbList for navigation
- FAQ for pages with question/answer content
- Validate JSON-LD syntax is correct.
Step 8 — Audit social media cards
Reference: Implementing Social Media Preview Cards
Check every page template includes:
Open Graph (Facebook/LinkedIn):
og:title, og:description, og:image, og:url, og:type
Twitter Card:
twitter:card, twitter:title, twitter:description, twitter:image
Verify og:image dimensions are at least 1200x630px. Fix missing or incomplete tags.
Step 9 — Audit For Unsubstantiated Claims
Ensure that all claims are backed up with a link to a reputable source. As an example, this claim isn't valid as content unless it links to an authority that found this through research:
Research shows teams with strong DevEx perform 4-5x better across speed, quality, and engagement
Search for the authoritative URL and add a link to the URL. If it is not available, change the claim to something that can be substantiated.
Step 10 — Audit Design Compliance
Read the design system docs at docs/specs/DESIGN-SYSTEM.md and view the design screens in docs/designs/.
- Colors match the defined palette (no hardcoded colors outside the system)
- CSS classes follow naming conventions (name classes after what the element IS, not what section it's in)
- No common LLM colors (purple, etc.) — all colors from the design system
- Consistent spacing, typography, and component usage
Step 11 — Test with Playwright
Build and run the website locally using make website-run (or the project's equivalent dev server command).
Desktop tests (1280x720):
- Navigate to the homepage — take a screenshot.
- Navigate to each major section — verify pages load without errors.
- Check the browser console for JavaScript errors.
- Verify all navigation links work.
Mobile tests (375x667, iPhone SE):
- Resize the browser to mobile dimensions.
- Navigate to the homepage — take a screenshot.
- Verify the layout is responsive (no horizontal overflow, readable text).
- Test navigation menu (hamburger menu if applicable).
If any page fails to load or has console errors, fix the issue and retest.
Step 12 — Report findings
Summarize the audit results:
## Website Audit Report
### Fixed
- [List each issue fixed with file and line reference]
### Warnings (manual review needed)
- [Issues that need human judgment]
### Passed
- [Areas that passed audit with no issues]
### Screenshots
- [Reference Playwright screenshots taken]
Rules
- Fix issues directly — don't just report them. Only flag issues as warnings when they require human judgment (e.g., content tone, keyword selection).
- One step at a time — complete each step before moving to the next.
- Preserve existing content — improve structure and metadata without rewriting the author's voice.
- No keyword stuffing — keywords must read naturally in context.
- Respect the framework — edit Eleventy templates/configs in
website/, not generated output files in website/_site/.