Merge docs across languages into a unified docs set #104
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Ignore scratch folder used for temporary files and planning to keep the repository clean of development artifacts.
- Add comprehensive unified docs for flows, content generation, RAG, evaluation, dotprompt, and tool calling - Integrate language preference script for enhanced user experience - Update sidebar configuration to include new documentation sections
Create complete documentation hierarchy under unified-docs/ including: - Core concepts (chat sessions, context, error handling, interrupts) - Getting started and deployment guides - Framework integrations (Express, Next.js) - Plugin documentation for AI providers (OpenAI, Anthropic, Google AI, etc.) - Vector database integrations (Pinecone, ChromaDB, Neo4j, etc.) - Developer tools, observability, and multi-agent systems - Plugin authoring guides and MCP server documentation Update sidebar configuration to support new documentation structure.
- Add deployment guides for any platform, authorization, Cloud Run, and Firebase - Add Model Context Protocol documentation - Add vector database guides for Cloud Firestore and dev local vectorstore - Update tool calling documentation and sidebar navigation - Provide platform-agnostic deployment options with security best practices
- Split observability-monitoring.mdx into dedicated sections - Add new observability docs: overview, authentication, advanced-configuration, troubleshooting - Remove broken links to non-existent framework docs (Gin, Flask, FastAPI) - Update sidebar navigation to reflect new structure
Fix broken authentication links in Express.js and Next.js framework documentation by updating the path from `/unified-docs/auth` to `/unified-docs/deployment/authorization` and correcting the link text from "authentication" to "authorization" patterns.
- Add LanguageContent.astro component for conditional content display - Add LanguageSelector.astro with tab-based language switching - Implement CSS-based content visibility using data attributes - Update get-started.mdx to use new language-specific sections - Add URL parameter support for language persistence
- Replace separate LanguageSelector class with unified page manager - Remove standalone language-preference.js script - Consolidate language switching and scroll restoration logic - Add scroll flash prevention to critical CSS - Improve code organization and maintainability
Replace full-page opacity changes with selective CSS class approach that hides only main content during scroll restoration while keeping navigation elements visible. Reduces transition time and improves UX.
Replace @astrojs/starlight Tabs and TabItem components with custom LanguageSelector and LanguageContent components throughout the unified documentation. This standardizes the language-specific content presentation and improves the user experience for multi-language documentation.
- Add CopyMarkdownButton component with copy-to-clipboard functionality - Implement markdown-copy.js script to filter content by selected language - Update LanguageSelector styling for better alignment with copy button - Add API endpoint to serve filtered markdown content - Integrate copy button into get-started page layout
- Add center justification and text alignment for better button appearance - Increase border radius from 0.5rem to 0.75rem for softer look - Add line-height and margin reset for consistent text positioning - Reduce bottom margin in get-started page layout
Remove trailing slash from current path before constructing language-specific markdown endpoint to prevent double slashes in URLs.
Implement a comprehensive system to generate language-specific llms.txt files from unified documentation. Adds custom processor to filter content by programming language (JS/Go/Python) and organize into thematic sets. - Add process-unified-llms.ts for content filtering and cleaning - Update astro.config.mjs to use unified docs paths - Add README-llms-txt.md documenting the system architecture - Configure gitignore for generated llms.txt build artifacts - Generate separate files for each language and topic combination
Add CopyMarkdownButton component alongside LanguageSelector in a flex container across all unified documentation pages to improve user experience and content accessibility.
- Remove starlight-llms-txt plugin dependency and configuration - Rename process-unified-llms.ts to generate-llms-direct.ts - Extract content processing logic into new content-processor utility - Simplify slug page generation by using extracted utilities - Update package dependencies accordingly
Automatically update URL with lang parameter when user has stored language preference but URL lacks the parameter, ensuring consistent state between localStorage and URL across page loads.
- Generate canonical URL without language parameters - Insert canonical link tag in document head - Helps prevent duplicate content issues across language variants
- Generate context-aware meta descriptions based on page type and content - Add Open Graph tags for better social media sharing - Include Twitter Card metadata for enhanced link previews - Improve SEO with targeted descriptions for different documentation sections
- Add JSON-LD structured data for better SEO with TechnicalArticle and BreadcrumbList schemas - Include font preloading for Core Web Vitals optimization - Add aria-label and fallback text to video element for accessibility compliance
- Add Genkit CLI installation instructions for Go and Python sections - Enhance Go example with structured recipe generation using schemas - Improve Python example with proper flow definition and structured output - Move flow benefits explanation to a more logical position - Add comprehensive error handling and JSON marshaling examples
- Replace npm global install with curl-based installation script - Remove Node.js requirement from Python prerequisites - Update installation instructions for Go and Python languages - Simplify Developer UI setup section by removing redundant CLI install step
- Add new plugins overview documentation page - Enhance generating-content.mdx with model selection examples - Show both default and specific model usage patterns - Update sidebar navigation to include plugins section - Streamline content by removing redundant explanatory text
Replace string inputs with typed objects (MenuSuggestionInput) and add structured outputs across TypeScript, Go, and Python examples. This improves type safety, API consistency, and developer experience in the unified documentation.
- Add support for multiple languages per content block (e.g., "js go") - Implement intelligent language fallback when content unavailable - Add redirect notices for unsupported language combinations - Separate global language preference from current page language - Improve language selector to handle limited language support - Update CSS selectors to support space-separated language attributes
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.