feat: improve agent docs

.github/workflows/validate-readme.yml

@@ -5,16 +5,26 @@ on:
   pull_request:
     paths:
       - README.md
+      - src/components/*/README.md
 
 permissions:
   contents: read
   pull-requests: write
 
 jobs:
-  validate:
+  validate-package:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
       - uses: gravity-ui/readme-validator@v1
         with:
           type: package
+
+  validate-components:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: gravity-ui/readme-validator@v1
+        with:
+          type: component
+          paths: src/components/*/README.md

.gitignore

@@ -17,3 +17,4 @@ reports
 .DS_Store
 
 .vitest-*
+build

README.md

@@ -127,3 +127,7 @@ React date and time controls for Gravity UI apps — date/time pickers, calendar
 - **Requires uikit setup.** Render inside `ThemeProvider` and import `@gravity-ui/uikit/styles/styles.css`; `@gravity-ui/uikit` and `@gravity-ui/date-utils` are required peer dependencies.
 - **Locale is loaded, not just set.** Set language via `ThemeProvider` `lang`, but load the locale data first with `settings.loadLocale('ru')` from `@gravity-ui/date-utils`, or dates render in the default locale.
 - **Component-specific translations use `addLanguageKeysets`.** For languages beyond `en`/`ru`, register keysets via `addLanguageKeysets` from `@gravity-ui/uikit/i18n` using the `Keysets`/`PartialKeysets` types exported here.
+
+## Documentation for AI agents
+
+Agent-readable documentation for the installed version is located in `node_modules/@gravity-ui/date-components/dist/docs/INDEX.md`.

gulpfile.mjs

@@ -2,6 +2,7 @@ import {rm} from 'node:fs/promises';
 import path from 'node:path';
 
 import {addVirtualFile, createTypescriptProject} from '@gravity-ui/gulp-utils';
+import {buildDocs, createDefaultDocsConfig} from '@gravity-ui/readme-validator';
 import {dest, parallel, series, src, task} from 'gulp';
 import gulpSass from 'gulp-sass';
 import sourcemaps from 'gulp-sourcemaps';
@@ -95,9 +96,20 @@ task('styles', () => {
         .pipe(dest(path.resolve(BUILD_DIR, 'cjs')));
 });
 
+task('copy-docs', (done) => {
+    buildDocs({...createDefaultDocsConfig(), outDir: path.resolve(BUILD_DIR, 'docs')});
+    done();
+});
+
 task(
     'build',
-    series(['clean', parallel(['compile-to-esm', 'compile-to-cjs']), 'copy-i18n', 'styles']),
+    series([
+        'clean',
+        parallel(['compile-to-esm', 'compile-to-cjs']),
+        'copy-i18n',
+        'styles',
+        'copy-docs',
+    ]),
 );
 
 task('default', series(['build']));