Skip to content

Commit 9c3ba46

Browse files
committed
Docs: alignement des manuels et exemples avec l'architecture BuildContext et l'ouverture auto du dossier
1 parent 76f27dd commit 9c3ba46

3 files changed

Lines changed: 16 additions & 24 deletions

File tree

docs/contributing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ For a deeper dive into ARK's internal architecture, review our core specificatio
1717

1818
- **BuildContext Spec**: [docs/dev_docs/ARK_BuildContext_v1.0.md](dev_docs/ARK_BuildContext_v1.0.md)
1919
- **CLI Spec**: [docs/dev_docs/ARK_Cli_v1.1.md](dev_docs/ARK_Cli_v1.1.md)
20-
- **Locking Spec**: [docs/dev_docs/ARK_Locking_v1.0.md](dev_docs/ARK_Locking_v1.0.md)
20+
- **Locking Spec**: [docs/dev_docs/ARK_Locking_v1.1.md](dev_docs/ARK_Locking_v1.1.md)
2121

2222
## **Development Workflow**
2323

docs/dev_docs/ARK_Cli_v1.1.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -148,6 +148,7 @@ Initializes the current directory as a workspace.
148148
- **Default**: Validates `ark.yml` and builds using the configured engine.
149149
- **Engine Override**: `--engine <id>` uses a temporary engine without modifying `ark.yml`.
150150
- **Reproducible Rebuild**: `--lock [file]` rebuilds strictly from a lock file (default: `.ark/lock/latest.lock.yml`).
151+
- **Git State**: Automatically verifies if the current branch and commit match the lock. Offers automatic checkout on Linux.
151152
- **Constraint**: `--engine` and `--lock` cannot be used together.
152153

153154
---

docs/how_to_create_an_engine.md

Lines changed: 14 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -474,18 +474,19 @@ Notes.
474474

475475
- Use minimal list to avoid heavy installs.
476476

477-
1. on_success with output directory log.
477+
1. on_success with custom message.
478478

479479
```python
480480
def on_success(self, gui, file):
481-
out = getattr(self, "_output_dir", None)
482-
if out and out.text().strip():
483-
log_i18n_level(gui, "success", f"Sortie: {out.text()}", f"Output: {out.text()}")
481+
# ARK already opens the output directory.
482+
# Use this for additional engine-specific messages.
483+
log_i18n_level(gui, "success", "Build terminé!", "Build finished!")
484484
```
485485

486486
Notes.
487487

488488
- Keep logs short and actionable.
489+
- No need to manually open the folder.
489490

490491
1. mapping.json for a single library.
491492

@@ -580,27 +581,16 @@ Notes.
580581

581582
- Clean alignment for labels + widgets.
582583

583-
1. UI: output directory input.
584+
1. UI: rely on global configuration.
584585

585586
```python
586-
self._output_dir = QLineEdit()
587-
self._output_dir.setPlaceholderText("Output directory")
587+
# Do NOT create widgets for Output Directory or Icon.
588+
# These are managed globally in ark.yml and passed via BuildContext.
588589
```
589590

590591
Notes.
591592

592-
- Always give a hint.
593-
594-
1. UI: icon selector button.
595-
596-
```python
597-
btn = QPushButton("Choose Icon")
598-
btn.clicked.connect(self.select_icon)
599-
```
600-
601-
Notes.
602-
603-
- Keep the handler small, update a field.
593+
- Keeps the engine tab focused and clean.
604594

605595
1. UI: store data files list.
606596

@@ -755,16 +745,17 @@ Notes.
755745

756746
- Keep outputs in the project.
757747

758-
1. Normalize output path.
748+
1. Use context.output_dir.
759749

760750
```python
761-
out = os.path.abspath(self._output_dir.text().strip())
762-
cmd.extend(["--output-dir", out])
751+
# The core runner already ensures output_dir is absolute if needed.
752+
# Use it directly from the context.
753+
cmd.extend(["--output-dir", context.output_dir])
763754
```
764755

765756
Notes.
766757

767-
- Avoid relative path issues.
758+
- Avoids manual widget parsing and relative path issues.
768759

769760
1. Avoid duplicate args.
770761

0 commit comments

Comments
 (0)