Merge pull request #63 from 0xPlaygrounds/devops/ci-fix

devops: Add cargo check for all features + doc check

.github/workflows/ci.yaml

@@ -55,6 +55,8 @@ jobs:
 
       - name: Run clippy action
         uses: clechasseur/rs-clippy-check@v3
+        with:
+          args: --all-features
 
   test:
     name: stable / test
@@ -79,4 +81,25 @@ jobs:
         uses: actions-rs/cargo@v1
         with:
           command: nextest
-          args: run --all-features
+          args: run --all-features
+
+  doc:
+    name: stable / doc
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Install Rust stable
+        uses: actions-rust-lang/setup-rust-toolchain@v1
+        with:
+          components: rust-docs
+
+      # Required to compile rig-lancedb
+      - name: Install Protoc
+        uses: arduino/setup-protoc@v3
+
+      - name: Run cargo doc
+        run: cargo doc --no-deps --all-features
+        env:
+          RUSTDOCFLAGS: -D warnings

rig-core/src/completion.rs

@@ -439,14 +439,14 @@ impl<M: CompletionModel> CompletionRequestBuilder<M> {
     }
 
     /// Sets the max tokens for the completion request.
-    /// Only required for: [ Anthropic ]
+    /// Note: This is required if using Anthropic
     pub fn max_tokens(mut self, max_tokens: u64) -> Self {
         self.max_tokens = Some(max_tokens);
         self
     }
 
     /// Sets the max tokens for the completion request.
-    /// Only required for: [ Anthropic ]
+    /// Note: This is required if using Anthropic
     pub fn max_tokens_opt(mut self, max_tokens: Option<u64>) -> Self {
         self.max_tokens = max_tokens;
         self

rig-core/src/lib.rs

@@ -54,7 +54,7 @@
 //! Rig provides a common interface for working with vector stores and indexes. Specifically, the library
 //! provides the [VectorStore](crate::vector_store::VectorStore) and [VectorStoreIndex](crate::vector_store::VectorStoreIndex)
 //! traits, which can be implemented to define vector stores and indices respectively.
-//! Those can then be used as the knowledgebase for a [RagAgent](crate::rag::RagAgent), or
+//! Those can then be used as the knowledgebase for a RAG enabled [Agent](crate::agent::Agent), or
 //! as a source of context documents in a custom architecture that use multiple LLMs or agents.
 //!
 //! # Integrations