| 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.
This repo's website lives in Website/ and is built with Eleventy (eleventy.config.js) plus DocFX for API docs. Templates and content sources live under Website/src/; generated output is Website/_site/ (do NOT edit _site/ directly).
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 Eleventy. Don't just check the static content before the website is generated.
- Fix issues at the core where the static content templates are stored (
Website/src/) — not in the outputted HTML (Website/_site/).
- Never manually edit
Website/_site/.
- ENSURE THE FOOTER HAS A copyright link to nimblesite.co
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. The DataProvider/LQL specs under docs/specs/ describe the product's value propositions — pull factual claims from there.
Identify the website source files in Website/src/. The framework is Eleventy (templates as .njk/.md under Website/src/_includes/, data files under Website/src/_data/).
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 (LQL, DataProvider, source generator, transpiler, sync, RBAC, WebAuthn) defined clearly so AI can extract them?
- Freshness signals — Are dates, update timestamps, and authorship present?
Fix issues directly in the source files (Website/src/). For each fix, note what changed and why.
Step 3 — Audit SEO and keywords
- Search Google Trends for trending keywords related to "C# source generator", "SQL safe queries", "offline sync", "ORM alternative", "type-safe SQL".
- 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 in Website/src/.
Step 4 — Audit crawling and indexing
Reference: Overview of crawling and indexing topics
- robots.txt —
Website/src/robots.txt (passed through to _site/robots.txt). Verify it doesn't block important pages. Reference: robots.txt spec.
- Sitemap — generated by
Website/src/sitemap.njk. Verify all important pages are listed and no dead URLs are included. Reference: Sitemap guidelines.
- Meta robots tags — Check Eleventy templates for unintended
noindex or nofollow directives on pages that should be indexed.
Note: edit the generators (robots.txt, sitemap.njk), not the rendered output.
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 in Website/src/_includes/.
- Verify the structured data matches the page content (no misleading markup).
- Add missing structured data where appropriate:
- Organization/Person on the homepage
- Article/BlogPosting on blog posts (with author, datePublished, dateModified)
- BreadcrumbList for navigation
- FAQ for pages with question/answer content
- SoftwareSourceCode for the docs API pages
- 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 substatiated.
Step 10 — Audit Design Compliance
Read the design system specs (docs/specs/dataprovider-design-system.md, docs/specs/lql-design-system.md) and view the design screens in Website/Designs/ (HomePage.png, APIDoc.png, BlogsPage.png).
Step 11 — Test with Playwright
The repo already has Playwright configured at Website/playwright.config.ts. Build and run the website locally:
cd Website && npm run build && npm run start
Then run the configured tests, or drive the site manually with the playwright MCP tools.
Desktop tests (1280x720):
- Navigate to the homepage — take a screenshot.
- Navigate to each major section (docs, blog, API docs) — 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
Website/src/ templates and eleventy.config.js, never edit Website/_site/ generated output.