You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: AGENTS.md
+1-23Lines changed: 1 addition & 23 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,7 +26,6 @@ If a module contains a `MODULE.md` file, it is considered part of the module's c
26
26
-`cases/` — test cases
27
27
-`fixtures/` — test fixtures
28
28
-`mocks/` — test mocks
29
-
-`schemas/` — JSON/YAML schemas for fundamental project data structures
30
29
31
30
### CLI Commands
32
31
@@ -253,27 +252,6 @@ The project supports configuration via:
253
252
Main configuration files:
254
253
255
254
-`YFM_CONFIG_FILENAME` — configuration file name (usually `.yfm`)
256
-
- Schemas in `schemas/` — JSON/YAML schemas for validation
257
-
258
-
### Schemas Directory
259
-
260
-
The `schemas/` directory stores schemas for fundamental project data structures:
261
-
262
-
-**`toc-schema.yaml`** — schema for documentation table of contents (`toc.yaml`)
263
-
- Defines the structure of navigation and document hierarchy
264
-
265
-
-**`presets-schema.yaml`** — schema for template variables file (`presets.yaml`)
266
-
- Defines variables used for document templating
267
-
268
-
-**`leading-schema.yaml`** — schema for "leading" (overview) pages structure
269
-
- Defines the structure of summary/overview pages in documentation
270
-
271
-
-**`page-constructor-schema.yaml`** — schema for Page Constructor format
272
-
- Defines the format for generating HTML pages from YAML descriptions
273
-
- Based on [@gravity-ui/page-constructor](https://gravity-ui.com/ru/libraries/page-constructor)
274
-
- Used to create pages from JSON/YAML block-based configurations
275
-
276
-
**Important**: Schemas and TypeScript types must always be kept in sync. When modifying types in `src/` that correspond to a schema (e.g., `RawToc` ↔ `toc-schema.yaml`, `Preset` ↔ `presets-schema.yaml`), you must update the matching schema in `schemas/` and vice versa. A mismatch between schemas and code leads to bugs where valid input (per schema) is silently rejected by the implementation.
277
255
278
256
## Additional Resources
279
257
@@ -318,4 +296,4 @@ The `schemas/` directory stores schemas for fundamental project data structures:
318
296
4. When working with VCS (GitHub/Arcadia), token configuration is required in `.env` or `.yfm`
319
297
5.**All comments and documentation files (ADR, AGENTS.md, README, etc.) must be written in English**
320
298
6.**The `src/steps/` directory is deprecated. Do not add new code there. If you need to fix existing code, carefully move it to `commands/build/features/`**
321
-
7.**When changing TypeScript types that have a corresponding schema in `schemas/`, always update the schema to match, and vice versa**
299
+
7.**When changing TypeScript types that have a corresponding schema in [`schemas/`](https://github.com/diplodoc-platform/ajv), always update the schema to match, and vice versa**
0 commit comments