Skip to content

Conversation

@mibeco
Copy link
Owner

@mibeco mibeco commented May 20, 2025

Fix Documentation Enhancement Workflow

Issue Fixed

This PR fixes a critical issue in the documentation enhancement process. The enhanced documentation generated by Claude was not being included in the final build deployed to CloudFront.

Changes Made

  1. Added Documentation Enhancement Steps to GitHub Workflow:

    • Added boto3 installation
    • Added AWS credentials configuration
    • Added the Bedrock documentation enhancement step
  2. Updated mdBook Source Directory:

    • Changed from using docs/generated/* (basic docs) to docs/enhanced/* (Claude-enhanced docs)

Testing Done

  • Verified locally that the enhancement script works correctly
  • Confirmed that the enhanced documentation is comprehensive and user-friendly
  • Tested the workflow with the updated configuration

Benefits

  • Users now get access to the comprehensive, Claude-enhanced documentation
  • Documentation includes detailed sections on:
    • Clear introductions explaining command purpose
    • Command syntax with proper formatting
    • Detailed parameter descriptions
    • Practical examples for different use cases
    • Troubleshooting tips for common issues
    • Related commands for better navigation

kensave and others added 24 commits May 16, 2025 18:26
* [feat]: Add a new semantic_search_client crate that provides vector embedding and
    semantic search capabilities for the Amazon Q CLI. This implementation:

    - Supports text embedding generation using Candle and ONNX runtimes
    - Provides hardware acceleration via Metal on macOS
    - Implements efficient vector indexing for semantic search
    - Includes file processing utilities for various file types
    - Supports persistent storage of semantic contexts
    - Includes comprehensive test coverage

    This crate will enable memory bank functionality for Amazon Q, allowing
    users to create, manage, and search through semantic memory contexts.

    🤖 Assisted by [Amazon Q Developer](https://aws.amazon.com/q/developer)

* Update semantic_search_client dependencies in Cargo.toml

* Refactor embedder implementation for Linux platforms to use trait objects

This change modifies the semantic search client to use Box<dyn TextEmbedderTrait>
on Linux platforms instead of directly using CandleTextEmbedder. This provides
more flexibility and consistency with the implementation on macOS and Windows,
allowing for better extensibility and polymorphic behavior across all platforms.

* Update Cargo.lock file

* Remove redundant CandleTextEmbedder import for non-macOS/Windows platforms

* fix(semantic_search): Update conditional compilation flags for embedders

Update conditional compilation flags to match the new embedding model selection logic:
- Replace target_env="musl" conditions with target_os conditions
- Update TextEmbedder trait implementation to use macOS/Windows condition
- Ensure consistent conditions across all files

🤖 Assisted by [Amazon Q Developer](https://aws.amazon.com/q/developer)

---------

Co-authored-by: Kenneth Sanchez V <kennvene@amazon.com>
Co-authored-by: Kenneth Sanchez V <kennvene@amazon.com>
* fix Build

* fix: Removes flakey test

---------

Co-authored-by: Kenneth Sanchez V <kennvene@amazon.com>
@amazon-q-developer
Copy link

⏳ I'm reviewing this pull request for security vulnerabilities and code quality issues. I'll provide an update when I'm done

@amazon-q-developer
Copy link

✅ I finished the code review, and didn't find any security or code quality issues.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants