This commit implements extensive SEO improvements for the tzst documentation: ## Key Enhancements: ### 1. Sitemap & Crawling - Add sphinx-sitemap extension for automatic XML sitemap generation - Create robots.txt with crawler guidelines and sitemap reference - Configure html_baseurl for proper sitemap generation ### 2. Structured Data (Schema.org) - Add SoftwareApplication schema with detailed metadata - Implement BreadcrumbList schema for all pages - Add TechArticle schema for documentation pages - Create FAQPage schema for quickstart with 5 common Q&As - Add HowTo schema for examples page with step-by-step guide ### 3. Enhanced Meta Tags - Add comprehensive Open Graph tags (og:site_name, og:locale) - Enhance Twitter Card tags (twitter:site, twitter:creator) - Add article meta tags for proper attribution - Include rating and revisit-after tags ### 4. Page-Specific Optimization - Add SEO meta tags to development.md - Enhance all existing page meta tags - Implement page-specific canonical URLs - Add unique descriptions and keywords per page ### 5. Performance Optimization - Add preconnect hints for external domains - Add dns-prefetch for frequently accessed domains - Configure html_copy_source=False to reduce duplicate content - Hide unnecessary Sphinx links and branding ### 6. Documentation - Create comprehensive SEO_ENHANCEMENTS.md documenting all changes - Include best practices and monitoring recommendations - Provide verification steps and future enhancement ideas ## Benefits: - Improved search engine visibility and indexing - Rich snippets in search results - Better social media sharing previews - Enhanced click-through rates - Faster page discovery - Professional appearance ## Files Modified: - docs/conf.py - Sitemap config, meta tags, SEO settings - docs/requirements.txt - Add sphinx-sitemap dependency - docs/_templates/layout.html - Structured data, schemas - docs/development.md - Add page-specific meta tags - docs/_static/robots.txt - New file for crawler guidance - docs/SEO_ENHANCEMENTS.md - New comprehensive documentation
22 lines
471 B
Plaintext
22 lines
471 B
Plaintext
# robots.txt for tzst documentation
|
|
User-agent: *
|
|
Allow: /
|
|
|
|
# Sitemap location
|
|
Sitemap: https://tzst.xi-xu.me/sitemap.xml
|
|
|
|
# Disallow build artifacts and internal directories
|
|
Disallow: /_sources/
|
|
Disallow: /_static/*.js$
|
|
Disallow: /_images/
|
|
|
|
# Allow static assets like CSS and images
|
|
Allow: /_static/*.css$
|
|
Allow: /_static/*.png$
|
|
Allow: /_static/*.jpg$
|
|
Allow: /_static/*.ico$
|
|
Allow: /_static/*.svg$
|
|
|
|
# Crawl delay (optional, considerate to search engines)
|
|
Crawl-delay: 1
|