feat(46): setup jsDoc + metadata documentation

.codex/config.toml

@@ -6,14 +6,12 @@ approval_policy = "untrusted"
 sandbox_mode = "workspace-write"
 sandbox_workspace_write.network_access = true
 
+features.web_search_request = false
+
 project_root_markers = [".git"]
 project_doc_max_bytes = 32768 # 3MB
 project_doc_fallback_filenames = ["AGENTS.md"]
 
-[features]
-skills = true
-web_search_request = false
-
 [history]
 persistence = "save-all"
 max_bytes = 52428800 # 50MB

docs/.vitepress/config.ts

@@ -3,12 +3,17 @@ import { defineConfig } from "vitepress";
 import { groupIconMdPlugin, groupIconVitePlugin } from "vitepress-plugin-group-icons";
 import { viteStaticCopy } from "vite-plugin-static-copy";
 
+const hostname = "https://utils.duplojs.dev";
+const ogImage = new URL("/images/ogImage.png", hostname).toString();
+
 export default defineConfig({
 	title: "@duplojs/utils",
-	description: "Utilitaires fonctionnels et immutables avec une excellente expérience développeur",
 
 	base: "/",
 	cleanUrls: true,
+	sitemap: {
+		hostname,
+	},
 
 	transformPageData(pageData) {
 		const frontmatter = pageData.frontmatter ?? {};
@@ -35,6 +40,34 @@ export default defineConfig({
 				href: "/images/logo.ico",
 			},
 		],
+		[
+			"meta",
+			{
+				property: "og:type",
+				content: "website",
+			},
+		],
+		[
+			"meta",
+			{
+				property: "og:image",
+				content: ogImage,
+			},
+		],
+		[
+			"meta",
+			{
+				name: "twitter:card",
+				content: "summary_large_image",
+			},
+		],
+		[
+			"meta",
+			{
+				name: "twitter:image",
+				content: ogImage,
+			},
+		],
 	],
 
 	markdown: {
@@ -89,6 +122,10 @@ export default defineConfig({
 				icon: "npm",
 				link: "https://www.npmjs.com/package/@duplojs/utils",
 			},
+			{
+				icon: "linkedin",
+				link: "https://linkedin.com/company/duplojs",
+			},
 		],
 
 		search: {
@@ -98,6 +135,7 @@ export default defineConfig({
 
 	locales: {
 		fr: {
+			description: "Utilitaires fonctionnels et immutables avec une excellente expérience développeur",
 			label: "Français",
 			lang: "fr",
 			link: "/fr/",
@@ -219,6 +257,7 @@ export default defineConfig({
 			},
 		},
 		root: {
+			description: "Functional and unchanging utilities with an excellent developer experience",
 			label: "English",
 			lang: "en",
 			link: "/en/",

docs/en/v1/api/array/at.md

@@ -1,5 +1,6 @@
 ---
 outline: [2, 3]
+description: "The at() method returns the element at a given index (supports negative indexes)."
 prev:
   text: "toTuple"
   link: "/en/v1/api/array/toTuple"

docs/en/v1/api/array/chunk.md

@@ -1,5 +1,6 @@
 ---
 outline: [2, 3]
+description: "The chunk() function splits an array into subarrays of a fixed size and returns the list of these blocks. The last block may be shorter if the size does not divide the array."
 prev:
   text: "flatMap"
   link: "/en/v1/api/array/flatMap"

docs/en/v1/api/array/coalescing.md

@@ -1,5 +1,6 @@
 ---
 outline: [2, 3]
+description: "The coalescing() function takes a value or an array and normalizes it into an array. If the value is not already an array, it is wrapped in an array."
 prev:
   text: "findAndSpliceReplace"
   link: "/en/v1/api/array/findAndSpliceReplace"

docs/en/v1/api/array/concat.md

@@ -1,5 +1,6 @@
 ---
 outline: [2, 3]
+description: "The concat() function merges multiple arrays into a new continuous array."
 prev:
   text: "shift"
   link: "/en/v1/api/array/shift"

docs/en/v1/api/array/copyWithin.md

@@ -1,5 +1,6 @@
 ---
 outline: [2, 3]
+description: "The copyWithin() function copies a portion of the array to another location while remaining pure (the original array is cloned)."
 prev:
   text: "fillAll"
   link: "/en/v1/api/array/fillAll"

docs/en/v1/api/array/every.md

@@ -1,5 +1,6 @@
 ---
 outline: [2, 3]
+description: "The every() method checks whether all elements of an array satisfy a given condition."
 prev:
   text: "findLastIndex"
   link: "/en/v1/api/array/findLastIndex"

docs/en/v1/api/array/fill.md

@@ -1,5 +1,6 @@
 ---
 outline: [2, 3]
+description: "The fill() function fills a portion of an array with a given value and returns a modified copy."
 prev:
   text: "set"
   link: "/en/v1/api/array/set"

docs/en/v1/api/array/fillAll.md

@@ -1,5 +1,6 @@
 ---
 outline: [2, 3]
+description: "The fillAll() function replaces all the elements of an array with a single value and returns the result without altering the input."
 prev:
   text: "fill"
   link: "/en/v1/api/array/fill"

docs/en/v1/api/array/filter.md

@@ -1,5 +1,6 @@
 ---
 outline: [2, 3]
+description: "The filter() method selects the elements of an array that satisfy a predicate and returns a new array. It can also serve as a type guard to refine the typing of the kept elements."
 prev:
   text: "map"
   link: "/en/v1/api/array/map"

docs/en/v1/api/array/find.md

@@ -1,5 +1,6 @@
 ---
 outline: [2, 3]
+description: "The find() method returns the first element of an array that satisfies a given condition."
 prev:
   text: "isLastIndex"
   link: "/en/v1/api/array/isLastIndex"

docs/en/v1/api/array/findAndReplace.md

@@ -1,5 +1,6 @@
 ---
 outline: [2, 3]
+description: "The findAndReplace() function searches for the first element that satisfies a predicate, replaces it with a new value, and returns the updated array. If no element matches, it returns undefined."
 prev:
   text: "spliceReplace"
   link: "/en/v1/api/array/spliceReplace"

docs/en/v1/api/array/findAndSpliceDelete.md

@@ -1,5 +1,6 @@
 ---
 outline: [2, 3]
+description: "The findAndSpliceDelete() function searches for the first element that satisfies a predicate, then deletes deleteCount elements starting from that index."
 prev:
   text: "findAndReplace"
   link: "/en/v1/api/array/findAndReplace"

docs/en/v1/api/array/findAndSpliceInsert.md

@@ -1,5 +1,6 @@
 ---
 outline: [2, 3]
+description: "The findAndSpliceInsert() function searches for the first element that satisfies a predicate and inserts an array of elements at that position without deleting the found element."
 prev:
   text: "findAndSpliceDelete"
   link: "/en/v1/api/array/findAndSpliceDelete"

docs/en/v1/api/array/findAndSpliceReplace.md

@@ -1,5 +1,6 @@
 ---
 outline: [2, 3]
+description: "The findAndSpliceReplace() function looks for an element with a predicate and replaces it, along with the following elements, with an array of new values."
 prev:
   text: "findAndSpliceInsert"
   link: "/en/v1/api/array/findAndSpliceInsert"

docs/en/v1/api/array/findIndex.md

@@ -1,5 +1,6 @@
 ---
 outline: [2, 3]
+description: "The findIndex() method returns the index of the first element of an array that satisfies a given condition."
 prev:
   text: "findLast"
   link: "/en/v1/api/array/findLast"

docs/en/v1/api/array/findLast.md

@@ -1,5 +1,6 @@
 ---
 outline: [2, 3]
+description: "The findLast() method returns the last element of an array that satisfies a given condition."
 prev:
   text: "find"
   link: "/en/v1/api/array/find"

docs/en/v1/api/array/findLastIndex.md

@@ -1,5 +1,6 @@
 ---
 outline: [2, 3]
+description: "The findLastIndex() method returns the index of the last element of an array that satisfies a given condition."
 prev:
   text: "findIndex"
   link: "/en/v1/api/array/findIndex"

docs/en/v1/api/array/first.md

@@ -1,5 +1,6 @@
 ---
 outline: [2, 3]
+description: "The first() method returns the first element of an array."
 prev:
   text: "at"
   link: "/en/v1/api/array/at"

docs/en/v1/api/array/flat.md

@@ -1,5 +1,6 @@
 ---
 outline: [2, 3]
+description: "The flat() method flattens a nested array up to the requested depth and returns a new array containing the unrolled elements."
 prev:
   text: "slice"
   link: "/en/v1/api/array/slice"

docs/en/v1/api/array/flatMap.md

@@ -1,5 +1,6 @@
 ---
 outline: [2, 3]
+description: "The flatMap() method applies a transform function to each element and then automatically flattens the result by one level. It therefore combines map() and flat(1) in a single step."
 prev:
   text: "flat"
   link: "/en/v1/api/array/flat"

docs/en/v1/api/array/from.md

@@ -1,5 +1,6 @@
 ---
 outline: [2, 3]
+description: "The from() method creates an array from an iterable, an array-like object, or an async iterable."
 prev:
   text: "Array"
   link: "/en/v1/api/array/"

docs/en/v1/api/array/group.md

@@ -1,5 +1,6 @@
 ---
 outline: [2, 3]
+description: "The group() method groups the elements of an array according to a computed key and returns an object indexed by group name with the associated elements."
 prev:
   text: "join"
   link: "/en/v1/api/array/join"

docs/en/v1/api/array/includes.md

@@ -1,5 +1,6 @@
 ---
 outline: [2, 3]
+description: "The includes() method checks whether an array contains a given element."
 prev:
   text: "lengthEqual"
   link: "/en/v1/api/array/lengthEqual"

docs/en/v1/api/array/index.md

@@ -1,5 +1,6 @@
 ---
 outline: [2, 3]
+description: "Functions to manipulate arrays immutably and type-safely. All functions preserve the original array and return a new value."
 prev:
   text: 'Common'
   link: '/en/v1/api/common/'

docs/en/v1/api/array/indexOf.md

@@ -1,5 +1,6 @@
 ---
 outline: [2, 3]
+description: "The indexOf() method returns the index of the first occurrence of an element in an array."
 prev:
   text: "notIncludes"
   link: "/en/v1/api/array/notIncludes"

docs/en/v1/api/array/insert.md

@@ -1,5 +1,6 @@
 ---
 outline: [2, 3]
+description: "The insert() function adds a value to the end of an array and returns a new instance. The curried signature first accepts the array (array), then the value (input), which makes composition easier. (This function is similar to push(), but the order of arguments is reversed)."
 prev:
   text: "copyWithin"
   link: "/en/v1/api/array/copyWithin"

docs/en/v1/api/array/is.md

@@ -1,5 +1,6 @@
 ---
 outline: [2, 3]
+description: "The is() method checks whether a value is an array (type guard)."
 prev:
   text: "some"
   link: "/en/v1/api/array/some"

docs/en/v1/api/array/isLastIndex.md

@@ -1,5 +1,6 @@
 ---
 outline: [2, 3]
+description: "The isLastIndex() function indicates whether an index corresponds to the last element of an array. It is curried to fit easily into compositions or reductions."
 prev:
   text: "lastIndexOf"
   link: "/en/v1/api/array/lastIndexOf"

docs/en/v1/api/array/join.md

@@ -1,5 +1,6 @@
 ---
 outline: [2, 3]
+description: "The join() method concatenates the elements of an array of strings, inserting a separator between each of them. It respects the structure of tuples to statically compute the resulting string."
 prev:
   text: "reduceRight"
   link: "/en/v1/api/array/reduceRight"

docs/en/v1/api/array/last.md

@@ -1,5 +1,6 @@
 ---
 outline: [2, 3]
+description: "The last() method returns the last element of an array."
 prev:
   text: "first"
   link: "/en/v1/api/array/first"

docs/en/v1/api/array/lastIndexOf.md

@@ -1,5 +1,6 @@
 ---
 outline: [2, 3]
+description: "The lastIndexOf() method returns the index of the last occurrence of an element in an array."
 prev:
   text: "indexOf"
   link: "/en/v1/api/array/indexOf"

docs/en/v1/api/array/length.md

@@ -1,5 +1,6 @@
 ---
 outline: [2, 3]
+description: "The length() method returns the length of an array."
 prev:
   text: "toTuple"
   link: "/en/v1/api/array/toTuple"

docs/en/v1/api/array/lengthEqual.md

@@ -1,5 +1,6 @@
 ---
 outline: [2, 3]
+description: "The lengthEqual() function checks that an array contains exactly a given number of elements. It acts as a type guard to infer a fixed-length tuple."
 prev:
   text: "length"
   link: "/en/v1/api/array/length"

docs/en/v1/api/array/map.md

@@ -1,5 +1,6 @@
 ---
 outline: [2, 3]
+description: "The map() method applies a transform function to each element of an array and returns a new array containing the results, without modifying the input."
 prev:
   text: "is"
   link: "/en/v1/api/array/is"

docs/en/v1/api/array/maxElements.md

@@ -1,5 +1,6 @@
 ---
 outline: [2, 3]
+description: "The maxElements() function checks that an array contains at most a certain number of elements. It is handy for rejecting a list that is too long before an expensive process."
 prev:
   text: "minElements"
   link: "/en/v1/api/array/minElements"

docs/en/v1/api/array/maxOf.md

@@ -1,5 +1,6 @@
 ---
 outline: [2, 3]
+description: "The maxOf() function returns the largest numeric value of an array (or tuple) without touching the original."
 prev:
   text: "minOf"
   link: "/en/v1/api/array/minOf"

docs/en/v1/api/array/minElements.md

@@ -1,5 +1,6 @@
 ---
 outline: [2, 3]
+description: "The minElements() function checks that an array contains at least a given number of elements. It acts as a type guard, which allows TypeScript to infer a tuple of at least minLength elements."
 prev:
   text: "maxOf"
   link: "/en/v1/api/array/maxOf"

docs/en/v1/api/array/minOf.md

@@ -1,5 +1,6 @@
 ---
 outline: [2, 3]
+description: "The minOf() function returns the smallest numeric value of an array without modifying it. It accepts both classic arrays and immutable tuples."
 prev:
   text: "sum"
   link: "/en/v1/api/array/sum"

docs/en/v1/api/array/notIncludes.md

@@ -1,5 +1,6 @@
 ---
 outline: [2, 3]
+description: "The notIncludes() function checks that an array does not contain a given value and acts as a type guard to exclude this value from the typing."
 prev:
   text: "includes"
   link: "/en/v1/api/array/includes"

docs/en/v1/api/array/pop.md

@@ -1,5 +1,6 @@
 ---
 outline: [2, 3]
+description: "The pop() function returns a new array without its last element. Tuples are updated exactly (via PopTuple)."
 prev:
   text: "push"
   link: "/en/v1/api/array/push"

docs/en/v1/api/array/push.md

@@ -1,5 +1,6 @@
 ---
 outline: [2, 3]
+description: "The push() function adds one or more elements to the end of the array and returns a new instance, leaving the input intact."
 prev:
   text: "insert"
   link: "/en/v1/api/array/insert"

docs/en/v1/api/array/reduce.md

@@ -1,5 +1,6 @@
 ---
 outline: [2, 3]
+description: "The reduce() method aggregates the elements of an array from left to right by applying a function that carries state. It supports primitive values but also complex states via reduceFrom() and lets you exit the loop at any time thanks to exit()."
 prev:
   text: "sort"
   link: "/en/v1/api/array/sort"

docs/en/v1/api/array/reduceRight.md

@@ -1,5 +1,6 @@
 ---
 outline: [2, 3]
+description: "The reduceRight() method works like reduce() but iterates through the array from right to left. It is useful for composing functions, rebuilding a structure from the end, or processing a stack."
 prev:
   text: "reduce"
   link: "/en/v1/api/array/reduce"