Merge pull request #16 from solutions-territoire/refactor-documentation

Refactor documentation
solutions-territoire · Aug 21, 2024 · e27ac8d · e27ac8d
2 parents a0824bc + b16141e
commit e27ac8d
Show file tree

Hide file tree

Showing 51 changed files with 17 additions and 11 deletions.
diff --git a/.github/workflows/retype-action.yml b/.github/workflows/retype-action.yml
@@ -15,7 +15,7 @@ jobs:
       contents: write
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
 
       - uses: retypeapp/action-build@latest
 

diff --git a/Gemfile b/Gemfile
@@ -5,3 +5,4 @@ gemspec
 
 gem "gem-release"
 gem "simplecov_json_formatter"
+gem "sqlite3", "~> 1.4.0"
diff --git a/Rakefile b/Rakefile
@@ -3,11 +3,15 @@
 require "bundler/gem_tasks"
 require "appraisal"
 require "rspec/core/rake_task"
+require "rubocop/rake_task"
+require "standard/rake"
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
 
 desc "Run the full CI"
 task :default do
   if ENV["APPRAISAL_INITIALIZED"]
-    RSpec::Core::RakeTask.new(:spec)
     Rake::Task["spec"].invoke
   else
     # FYI: Standard & appraisal requires each a spawn process.
@@ -20,8 +24,9 @@ task :default do
     # report offenses from other plugins putted in .rubocop_todo.yml
     # https://github.com/testdouble/standard/issues/480
 
+    fail unless system "bundle exec appraisal install"
     fail unless system "bundle exec appraisal rspec"
     fail unless system "bundle exec rubocop"
-    fail unless system "bundle exec standardrb"
+    fail unless system "bundle exec rake standard"
   end
 end
diff --git a/docs/documentation/index.yml b/docs/documentation/index.yml
@@ -0,0 +1,5 @@
+icon: book-24
+label: Documentation
+order: -2
+expanded: true
+
diff --git a/docs/indexes/eager_loading.md → docs/documentation/indexes/eager_loading.md b/docs/indexes/eager_loading.md → docs/documentation/indexes/eager_loading.md
diff --git a/docs/indexes/index.yml → docs/documentation/indexes/index.yml b/docs/indexes/index.yml → docs/documentation/indexes/index.yml
diff --git a/docs/indexes/interdependencies.md → ...ocumentation/indexes/interdependencies.md b/docs/indexes/interdependencies.md → ...ocumentation/indexes/interdependencies.md
diff --git a/docs/indexes/partial_updates.md → .../documentation/indexes/partial_updates.md b/docs/indexes/partial_updates.md → .../documentation/indexes/partial_updates.md
diff --git a/docs/indexes/properties.md → docs/documentation/indexes/properties.md b/docs/indexes/properties.md → docs/documentation/indexes/properties.md
diff --git a/docs/indices/index.yml → docs/documentation/indices/index.yml b/docs/indices/index.yml → docs/documentation/indices/index.yml
diff --git a/docs/indices/mapping_setting.md → .../documentation/indices/mapping_setting.md b/docs/indices/mapping_setting.md → .../documentation/indices/mapping_setting.md
diff --git a/docs/indices/text_analysis.md → docs/documentation/indices/text_analysis.md b/docs/indices/text_analysis.md → docs/documentation/indices/text_analysis.md
diff --git a/docs/indices/versionning.md → docs/documentation/indices/versionning.md b/docs/indices/versionning.md → docs/documentation/indices/versionning.md
diff --git a/docs/models/add_caoutsearch.md → docs/documentation/models/add_caoutsearch.md b/docs/models/add_caoutsearch.md → docs/documentation/models/add_caoutsearch.md
diff --git a/docs/models/index.yml → docs/documentation/models/index.yml b/docs/models/index.yml → docs/documentation/models/index.yml
diff --git a/...els/index_records/asynchronous_methods.md → ...els/index_records/asynchronous_methods.md b/...els/index_records/asynchronous_methods.md → ...els/index_records/asynchronous_methods.md
diff --git a/...dels/index_records/automatic_callbacks.md → ...dels/index_records/automatic_callbacks.md b/...dels/index_records/automatic_callbacks.md → ...dels/index_records/automatic_callbacks.md
diff --git a/.../models/index_records/delete_documents.md → .../models/index_records/delete_documents.md b/.../models/index_records/delete_documents.md → .../models/index_records/delete_documents.md
diff --git a/docs/models/index_records/index.yml → ...umentation/models/index_records/index.yml b/docs/models/index_records/index.yml → ...umentation/models/index_records/index.yml
diff --git a/...s/index_records/index_multiple_records.md → ...s/index_records/index_multiple_records.md b/...s/index_records/index_multiple_records.md → ...s/index_records/index_multiple_records.md
diff --git a/...els/index_records/index_single_records.md → ...els/index_records/index_single_records.md b/...els/index_records/index_single_records.md → ...els/index_records/index_single_records.md
diff --git a/docs/models/search_records/index.yml → ...mentation/models/search_records/index.yml b/docs/models/search_records/index.yml → ...mentation/models/search_records/index.yml
diff --git a/docs/models/search_records/iteration.md → ...tation/models/search_records/iteration.md b/docs/models/search_records/iteration.md → ...tation/models/search_records/iteration.md
diff --git a/docs/models/search_records/pagination.md → ...ation/models/search_records/pagination.md b/docs/models/search_records/pagination.md → ...ation/models/search_records/pagination.md
diff --git a/docs/models/search_records/search_api.md → ...ation/models/search_records/search_api.md b/docs/models/search_records/search_api.md → ...ation/models/search_records/search_api.md
diff --git a/docs/models/search_records/total_count.md → ...tion/models/search_records/total_count.md b/docs/models/search_records/total_count.md → ...tion/models/search_records/total_count.md
diff --git a/docs/searches/aggregations.md → docs/documentation/searches/aggregations.md b/docs/searches/aggregations.md → docs/documentation/searches/aggregations.md
diff --git a/docs/searches/contexts.md → docs/documentation/searches/contexts.md b/docs/searches/contexts.md → docs/documentation/searches/contexts.md
diff --git a/docs/searches/custom_filters.md → .../documentation/searches/custom_filters.md b/docs/searches/custom_filters.md → .../documentation/searches/custom_filters.md
diff --git a/docs/searches/filters.md → docs/documentation/searches/filters.md b/docs/searches/filters.md → docs/documentation/searches/filters.md
diff --git a/docs/searches/filters/boolean.md → ...documentation/searches/filters/boolean.md b/docs/searches/filters/boolean.md → ...documentation/searches/filters/boolean.md
diff --git a/docs/searches/filters/date.md → docs/documentation/searches/filters/date.md b/docs/searches/filters/date.md → docs/documentation/searches/filters/date.md
diff --git a/docs/searches/filters/defaults.md → ...ocumentation/searches/filters/defaults.md b/docs/searches/filters/defaults.md → ...ocumentation/searches/filters/defaults.md
diff --git a/docs/searches/filters/geopoint.md → ...ocumentation/searches/filters/geopoint.md b/docs/searches/filters/geopoint.md → ...ocumentation/searches/filters/geopoint.md
diff --git a/docs/searches/filters/index.yml → .../documentation/searches/filters/index.yml b/docs/searches/filters/index.yml → .../documentation/searches/filters/index.yml
diff --git a/docs/searches/filters/match.md → docs/documentation/searches/filters/match.md b/docs/searches/filters/match.md → docs/documentation/searches/filters/match.md
diff --git a/docs/searches/filters/range.md → docs/documentation/searches/filters/range.md b/docs/searches/filters/range.md → docs/documentation/searches/filters/range.md
diff --git a/docs/searches/full_text_query.md → ...documentation/searches/full_text_query.md b/docs/searches/full_text_query.md → ...documentation/searches/full_text_query.md
diff --git a/docs/searches/index.yml → docs/documentation/searches/index.yml b/docs/searches/index.yml → docs/documentation/searches/index.yml
diff --git a/docs/searches/loading_records.md → ...documentation/searches/loading_records.md b/docs/searches/loading_records.md → ...documentation/searches/loading_records.md
diff --git a/docs/searches/orders.md → docs/documentation/searches/orders.md b/docs/searches/orders.md → docs/documentation/searches/orders.md
diff --git a/docs/searches/queries.md → docs/documentation/searches/queries.md b/docs/searches/queries.md → docs/documentation/searches/queries.md
diff --git a/docs/searches/responses.md → docs/documentation/searches/responses.md b/docs/searches/responses.md → docs/documentation/searches/responses.md
diff --git a/docs/searches/transform_aggregations.md → ...tation/searches/transform_aggregations.md b/docs/searches/transform_aggregations.md → ...tation/searches/transform_aggregations.md
diff --git a/docs/testing.md → docs/documentation/testing.md b/docs/testing.md → docs/documentation/testing.md
diff --git a/getting_started.md → docs/getting_started.md b/getting_started.md → docs/getting_started.md
diff --git a/getting_started.yml → docs/getting_started.yml b/getting_started.yml → docs/getting_started.yml
diff --git a/index.md → docs/index.md b/index.md → docs/index.md
diff --git a/docs/index.yml b/docs/index.yml
@@ -1,5 +1,2 @@
-icon: book-24
-label: Documentation
-order: -2
-expanded: true
-
+title: Overview
+icon: home
diff --git a/index.yml b/index.yml
diff --git a/retype.yml b/retype.yml
@@ -1,4 +1,4 @@
-input: .
+input: ./docs
 output: .retype
 url: https://solutions-territoire.github.io/caoutsearch
Original file line number	Diff line number	Diff line change
Expand Up		@@ -5,3 +5,4 @@ gemspec

		gem "gem-release"
		gem "simplecov_json_formatter"
		gem "sqlite3", "~> 1.4.0"