Skip to content

SEO_GUIDE.md

Latest commit

 

History

History
54 lines (42 loc) · 1.73 KB

SEO_GUIDE.md

File metadata and controls

54 lines (42 loc) · 1.73 KB
Raw

YGIT Documentation SEO Guide

Search intent map

Surface Primary search intent
Homepage YGIT deployment automation, Git to Cloudflare Pages
User Docs How to use YGIT, connect GitHub, connect Cloudflare, deploy repository
CLI YGIT CLI install, login, init, deploy, JSON output
SDK YGIT SDK and language client documentation
API YGIT API authentication, resources, errors, deployments
Updates YGIT releases and documentation changes

Page requirements

Every documentation page must include:

---
title: Clear page title
description: A unique summary of the page and user outcome.
sidebar_position: 1
---

Use one H1 per page, task-oriented H2 headings, descriptive link text, and screenshots with meaningful alt text.

Writing rules

  • Put the answer or task outcome near the top.
  • Use product terminology consistently.
  • Avoid keyword repetition and unverifiable superlatives.
  • Link to the next logical task.
  • Label preview and planned features.
  • Keep URLs stable; use redirects when changing public slugs.

Technical controls

  • Canonical site URL comes from SITE_URL.
  • Docusaurus generates sitemap.xml.
  • static/robots.txt permits crawling.
  • static/img/social-card.svg provides a social preview.
  • Structured data identifies YGIT as a developer application.
  • Broken links fail the production build.

Pre-release SEO audit

  1. Confirm the production domain.
  2. Update SITE_URL and static/robots.txt if the domain differs from ygit.dev.
  3. Verify unique titles and descriptions.
  4. Check canonical links in the production HTML.
  5. Inspect sitemap and robots files.
  6. Test social-preview metadata.
  7. Submit the sitemap through the selected search-engine webmaster tools.