Move topic pages to section index routes, standardize card-based content presentation, and simplify metadata typing while improving local search indexing for EnhancedLink entries. Refresh theme styling and replace unstable external links to keep metadata builds reliable.
Added missing site generators from README.md:
- Framework-specific: VuePress, Gatsby Docs Kit, MDX-GO, Fumadocs, Vocs
- Lightweight: Hugo was completely missing
- Enterprise: Document Node, Docsite, Portray, RcPress, xyd
- Experimental: Dokz, Gridsome
Enhanced extensions sections:
- Added Hugo Extensions
- Expanded Sphinx Extensions with consoletest, Contentui, Sphinx Substitution Extensions
- Added complete Sphinx Themes collection
Organization improvements:
- Better categorization by use case and target audience
- Added Hugo which was a major missing piece
- All generators from README.md now properly documented
- Maintained consistent structure with descriptions and best-use cases
This resolves the missing site generators issue.
Created comprehensive pages for all sections referenced in navigation:
- writing.md: Writing tools, editors, knowledge bases, mockup tools, screenshots, screencasts, and learning resources
- style-guides.md: Complete collection of style guides from government, tech companies, and specialized domains
- reading.md: Essential articles, guides, and resources organized by topic (strategy, skills, APIs, UX, accessibility, etc.)
- github-actions.md: GitHub Actions for documentation validation, content generation, and quality assurance with workflow examples
- tools.md: Additional specialized tools covering AsciiDoc, browser testing, accessibility, hosting, utilities, and analytics
Updated VitePress config:
- Added all new pages to navigation menus
- Organized tools into logical categories
- Fixed 404 errors for previously missing routes
Content migration status:
- All major sections from README.md now have dedicated pages
- Navigation links properly connected to existing content
- Structured content with clear categories and descriptions
- Cross-references between related sections
This completes the content migration from the original README.md structure to a comprehensive VitePress documentation site.
Landing page improvements:
- Removed Contributing and License sections for cleaner focus
- Updated Quick Start to remove external GitHub links
- Added Popular Tools section with beginner-friendly recommendations
- Organized tools by category (Beginners, API Documentation, QA)
- Added subtle call-to-action footer linking to contributing page
- Improved navigation flow to keep users on the documentation site
Contributing page enhancements:
- Merged license information from landing page
- Added comprehensive Community & Recognition section
- Included contributor acknowledgments and impact explanation
- Added detailed license explanation (CC0 1.0 Universal)
- Clarified contributing agreement and licensing terms
- Enhanced getting help and community sections
Benefits:
- Landing page is now focused on discovering and using tools
- All contributor/legal information consolidated in one place
- Better user flow from discovery to contribution
- Cleaner separation of concerns between user and contributor content
- Maintained important information while improving organization
- Created new 'Contributing' section for developer-focused content
- Moved installation instructions from guide/installation to contributing/
- Updated installation guide to use Taskfile commands instead of raw pnpm
- Added comprehensive contributing guidelines including:
- Development setup using task commands (setup:deps, docs:dev, etc.)
- Project structure and workflow explanations
- Contribution guidelines and review process
- Development tips and testing procedures
- Updated navigation to include Contributing as top-level item
- Reorganized sidebar to remove installation from Getting Started
- Updated main guide to focus on using documentation vs. contributing
- Removed old guide/installation.md and empty guide/ directory
New structure better separates:
- Guide: For documentation users (how to find and use resources)
- Contributing: For project contributors (how to develop and contribute)
Task commands highlighted:
- task setup:deps (install dependencies)
- task docs:dev (development server)
- task docs:build (build site)
- task docs:preview (preview built site)
- Restructured homepage with clear category overview
- Created comprehensive Site Generators page with detailed tool descriptions
- Built API Documentation page covering tools, testing, and best practices
- Added Quality Assurance page with linting, testing, and accessibility tools
- Updated navigation with organized tool categories and resources
- Enhanced sidebar with logical content grouping
- Transformed flat README list into searchable, navigable documentation
New structure:
- Core Tools: Site Generators, API Documentation
- Content & Quality: Writing Tools, Quality Assurance
- Resources: Style Guides, Reading List, GitHub Actions
- Getting Started: Introduction, Installation
All content now properly categorized and easily discoverable through navigation and search.
- Moved 'install' task from docs to setup as 'deps'
- Added dependencies to setup:deps (requires node and pnpm)
- Logical separation:
- setup: Environment and dependency installation
- docs: Documentation workflow (dev, build, preview)
New task structure:
Setup tasks:
- setup:node: Install Node.js if missing
- setup:pnpm: Install pnpm if missing
- setup:deps: Install VitePress dependencies
Docs tasks:
- docs:dev: Development server
- docs:build: Build site
- docs:preview: Preview built site
- Replaced Yarn with pnpm commands
- Replaced Docusaurus with VitePress commands
- Removed 'dir: website' since VitePress runs from project root
- Updated task descriptions to reflect VitePress
- Added 'preview' task for built site preview
- Renamed 'serve' to 'dev' to match pnpm script names
Available tasks:
- docs:install: Install VitePress dependencies
- docs:dev: Run development server
- docs:build: Build static site
- docs:preview: Preview built site
- Added local search provider configuration
- Enhanced search with custom translations and options
- Created API reference page with searchable content
- Updated navigation to include API section
- Added Reference section to sidebar
- Search now indexes all documentation content
- Created 16x16 ICO favicon for better compatibility
- Added SVG favicon as primary option for modern browsers
- Simplified VitePress configuration
- Added fallback favicon files in multiple locations
- Updated head configuration for better browser support
- Downloaded favicon.png from ocular-d/asciidoclint
- Created favicon.ico for better browser compatibility
- Updated VitePress config with comprehensive favicon support
- Added favicons to docs/public/ directory
- Configured multiple favicon formats for cross-browser compatibility
- Created custom theme with CSS overrides
- Set brand colors to #5469d4 for both light and dark themes
- Added hover effects for better user experience
- Links now use the specified blue color consistently
- Added VitePress as dev dependency
- Created docs directory structure
- Configured VitePress with navigation and sidebar
- Added example pages (home, guide, installation)
- Updated package.json with docs scripts
- Added VitePress-specific entries to .gitignore
- Created setup documentation
