xixu-me/tzst
1
0 Fork 0
Code Issues Pull Requests Actions 7 Packages Projects Releases Wiki Activity
237 Commits 2 Branches 9 Tags
68ec8bfbcf4fc2511a65e83ea271cc40862fc7df
Commit Graph
12 Commits
Author SHA1 Message Date
google-labs-jules[bot] 1f4b77ffc7 Update copyright year to be dynamic and sync docs with README 
- Update `docs/conf.py` to use `datetime` for dynamic copyright year.
- Update `docs/quickstart.md` to match installation instructions from `README.md`.
- Remove redundant installation details from `docs/index.md` and link to `quickstart`.
 2025-12-31 17:05:26 +00:00
Claude 40c7724bcb Remove SEO_ENHANCEMENTS.md documentation file 
- Delete SEO_ENHANCEMENTS.md to keep docs directory clean
- Remove from exclude_patterns in conf.py
- SEO enhancements remain in place and functional
 2025-11-12 15:18:52 +00:00
Claude a316a8ac2e Fix documentation build: exclude SEO_ENHANCEMENTS.md and clean template formatting 
- Add SEO_ENHANCEMENTS.md to exclude_patterns to prevent Sphinx warnings
- Clean up layout.html template formatting for better compatibility
- Split template tags across multiple lines for readability
 2025-11-12 15:16:43 +00:00
Claude 9e741b6f8f Enhance documentation SEO with comprehensive optimizations 
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
 2025-11-12 14:48:58 +00:00
xixu-me 9b9ad446c1 Update docs and remove CLI interactive option 
Updated the Sphinx configuration to set 'includehidden' to False and revised the documentation index to streamline content. Removed the '--interactive' option from CLI commands 'extract' and 'extract_flat' as it is no longer supported.
 2025-06-06 20:27:47 +08:00
xixu-me 27e1809bf9 Update documentation URLs to new domain 
Replaced all occurrences of the old domain 'xixu-me.github.io/tzst' with the new domain 'tzst.xi-xu.me' in layout.html and conf.py for improved SEO and consistency.
 2025-06-06 19:59:46 +08:00
xixu-me 4d3d34051f Update Sphinx config and documentation index 
Added 'sphinx.ext.coverage' to the Sphinx extensions in conf.py to enable coverage reporting. Removed 'README' and '404' entries from the documentation index in index.md for cleanup.
 2025-06-06 19:50:17 +08:00
xixu-me 8b39da60da Update documentation structure and metadata 
Added favicon and logo to the static assets. Updated layout.html for improved SEO and performance. Migrated metadata in documentation files to use 'myst' format for consistency. Adjusted configuration in conf.py and fixed formatting issues.
 2025-06-06 18:34:17 +08:00
xixu-me b5f7fa8dca Enhance documentation with SEO metadata and layout 
Added a new custom layout template for SEO and social media meta tags. Updated multiple documentation files with metadata for improved search engine optimization and social sharing. Enhanced Sphinx configuration with additional HTML options and meta tags.
 2025-06-06 17:50:43 +08:00
xixu-me 23dcdab305 Update documentation structure and configuration 
Revised Sphinx directives in CLI and exceptions API docs to use ':no-index' instead of ':members', ':undoc-members', and ':show-inheritance'. Removed 'display_version' from Sphinx configuration. Added 'README' to the index page for better navigation.
 2025-06-06 15:47:38 +08:00
xixu-me a5f342f556 Final documentation cleanup and refinements 2025-06-02 21:26:20 +08:00
xixu-me cfb8290dea Add comprehensive Sphinx documentation with GitHub Pages deployment 
- Complete documentation structure with index, quickstart, examples, and API reference
- Sphinx configuration with RTD theme, MyST parser, and autodoc
- GitHub Actions workflow for automated documentation building and deployment
- Local development tools (Makefile, build scripts)
- Comprehensive examples covering basic usage, security, and performance
- API documentation for core, CLI, and exceptions modules
 2025-06-02 21:11:45 +08:00