Skip to content

Commit 4a652d0

Browse files
committed
update developers.md
Signed-off-by: sirutBuasai <sirutbuasai27@outlook.com>
1 parent 96c72e1 commit 4a652d0

File tree

13 files changed

+379
-462
lines changed

13 files changed

+379
-462
lines changed

.kiro/steering/docs.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,8 @@ docs/src/
2828
│ ├── pytorch-inference.yml
2929
│ └── ...
3030
├── data/ # Image configs (one file per image)
31+
│ ├── template/
32+
│ │ └── image-template.yml # Template with all possible fields documented
3133
│ ├── pytorch-training/
3234
│ │ ├── 2.9-gpu-ec2.yml
3335
│ │ ├── 2.9-cpu-sagemaker.yml
@@ -442,3 +444,5 @@ pytorch:
442444
If there are any new changes to the documentations generation and organization, make sure to update you knowledge base in the steering/docs.md file and any runbook or update to processes should also be updated in DEVELOPMENT.md files.
443445
This is done so that developers get the most up-to-date information on the current codebase. Be sure to not let this steering document get too large since it will overflow the context window.
444446
If the document gets longer than 500 lines, make sure to delete unnecessary sections and condense verbose sections where necessary. Also, do not delete comments unless the it is unnecessary.
447+
448+
When making changes to image config field reading or processing, update `docs/src/data/template/image-template.yml` to reflect those changes.

.pre-commit-config.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ repos:
104104
language: python
105105
additional_dependencies: [flowmark]
106106
files: ^docs/
107-
exclude: (\.template\.md$|/\.venv/)
107+
exclude: (\.template\.md$|DEVELOPMENT\.md$)
108108
types: [markdown]
109109

110110
- repo: https://github.com/hukkin/mdformat

0 commit comments

Comments
 (0)