diff --git a/.vale.ini b/.vale.ini index 5bbce807fcd0440379e81c423ce0b6e5aa5fee1b..0eb17152be78b217b955ffda657fe083cdb50eb2 100644 --- a/.vale.ini +++ b/.vale.ini @@ -12,7 +12,3 @@ BasedOnStyles = gitlab_base, gitlab_docs # Ignore SVG markup TokenIgnores = (\*\*\{\w*\}\*\*) - -# Exclude gem documentation from GitLab docs rules -[gems/**/*.md] -BasedOnStyles = diff --git a/doc/development/ai_features/glossary.md b/doc/development/ai_features/glossary.md index 0fa186c3e8113e98f6b427589ebab09b2ea2e8e6..42bff17e0d3e351eb33097711133f8d18f89d4c5 100644 --- a/doc/development/ai_features/glossary.md +++ b/doc/development/ai_features/glossary.md @@ -261,7 +261,7 @@ context-aware code suggestions and generation. ### AI Context Abstraction Layer -A [Ruby gem](https://gitlab.com/gitlab-org/gitlab/-/tree/master/gems/gitlab-active-context) that provides a unified interface for Retrieval Augmented Generation (RAG) across multiple vector databases within GitLab. The system abstracts away the differences between Elasticsearch, OpenSearch, and PostgreSQL with pgvector, enabling AI features to work regardless of the underlying storage solution. +A [Ruby gem](https://gitlab.com/gitlab-org/gitlab/-/tree/master/gems/gitlab-active-context) that provides a unified interface for Retrieval Augmented Generation (RAG) across multiple vector databases in GitLab. The system abstracts away the differences between Elasticsearch, OpenSearch, and PostgreSQL with pgvector, enabling AI features to work regardless of the underlying storage solution. Key components include collections that define data schemas and reference classes that handle serialization, migrations for schema management, and preprocessors for embedding generation. The layer supports automatic model migration between different LLMs without downtime, asynchronous processing through Redis-backed queues, and permission-aware search with automatic redaction. diff --git a/gems/gitlab-active-context/doc/usage.md b/gems/gitlab-active-context/doc/usage.md index 2b6eb5b406c218d45dd0b757f618c0dfbf3e3e76..06c85679e81e19a84312c1043038bc7015ae7332 100644 --- a/gems/gitlab-active-context/doc/usage.md +++ b/gems/gitlab-active-context/doc/usage.md @@ -2,7 +2,7 @@ ## Creating a migration -Migrations are similiar to database migrations: they create collections, update schemas, run backfills, etc. +Migrations are similar to database migrations: they create collections, update schemas, run backfills, etc. See [migrations](migrations.md) for more details. diff --git a/scripts/lint-doc.sh b/scripts/lint-doc.sh index 6f7da391f138613686f411761c371cfa3d2be839..f3d6c065b6c536734983091a9ec523e56454b62e 100755 --- a/scripts/lint-doc.sh +++ b/scripts/lint-doc.sh @@ -153,7 +153,7 @@ then ruby -r './tooling/lib/tooling/find_changes' -e "Tooling::FindChanges.new( from: :api, changed_files_pathname: '${DOC_CHANGES_FILE}', - file_filter: ->(file) { !file['deleted_file'] && file['new_path'] =~ %r{doc/.*\.md|\.vale|\.markdownlint|lint-doc\.sh|docs\.gitlab-ci\.yml} }, + file_filter: ->(file) { !file['deleted_file'] && file['new_path'] =~ %r{\A(?:doc/(.*\.md|\.markdownlint|\.vale)|\.vale\.ini|\.markdownlint-cli2.yaml|scripts/lint-doc\.sh|\.gitlab/ci/docs\.gitlab-ci\.yml)} }, only_new_paths: true ).execute" if grep -E "\.vale|\.markdownlint|lint-doc\.sh|docs\.gitlab-ci\.yml" < $DOC_CHANGES_FILE