baram2584/AbaqusSubroutineDev
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: add AI manual section index

Browse Source
This commit is contained in:
KOKO\Mimi
2026-08-18 03:00:21 +09:00
parent d455e0843e
commit c5dfb7ae99
4 changed files with 6033 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
PROGRESS.md
+27
View File
@@ -10,6 +10,13 @@
## Completed
- Completed the AI-agent-oriented Abaqus User Subroutine Manual index.
- Created `docs/AbaqusUserSubroutineManual/INDEX_DESIGN.md` with schema, generation, boundary, retrieval, and validation rules.
- Created `docs/AbaqusUserSubroutineManual/INDEX.md` with 115 unique leaf-section records across 69 Markdown chunks.
- Included explicit per-file source ranges, source pages, stable headings, summaries, keywords, and selected content anchors.
- Added Appendix A.1/A.2 records and regression checks for CREEP, the `1.3.2` chapter boundary, and the three-file `2.1.23 ALLOCATABLE ARRAYS` span.
- Used schema version 2 `products` lists sourced from explicit manual `Product:`/`Products:` declarations when present, including Aqua applicability for UWAVE, VWAVE, and utility topics.
- Declared the 69 unbundled manual chunks and matching source digest as mandatory external-local prerequisites.
- Created phase scaffold under `phases/uel-3d-euler-beam`.
- Added shared coordination files: `PLAN.md`, `PROGRESS.md`, `WORKNOTE.md`.
- Updated `AGENTS.md` to require agents to read and maintain the shared coordination files.
@@ -70,6 +77,26 @@
## Last Verification
Latest verification for the manual index documentation task:
```bash
python -c "import pathlib,re,yaml; t=pathlib.Path('docs/AbaqusUserSubroutineManual/INDEX.md').read_text(encoding='utf-8'); b=re.findall(r'```yaml\\n(.*?)\\n```',t,re.S); r=[yaml.safe_load(x) for x in b[1:]]; assert len(b)==116 and len(r)==115 and len({x['section_id'] for x in r})==115; print('PASS: 116 YAML blocks, 115 unique records')"
rg -n -g "AbaqusUserSubroutineManual_*.md" "^# (?:[0-9]+\\.[0-9]+\\.[0-9]+|A\\.[0-9]+) " docs/AbaqusUserSubroutineManual
python scripts/validate_workspace.py
python -m unittest discover -s scripts -p "test_*.py"
git diff --cached --check
```
Result:
- Final independent index validation passed: 69 source files; 115 ordered unique records; 116 valid YAML blocks; exact structural boundaries, source pages, headings, source-backed product applicability, anchors, source digest, and no placeholders.
- Explicit regressions passed for CREEP (`_002.md:96-249`, `_003.md:1-390`), `1.3.2` (`_059.md:178-374`, `_060.md:1-13`), and `2.1.23` (`_066.md:99-245`, `_067.md:1-383`, `_068.md:1-222`).
- UWAVE and VWAVE include their explicit Abaqus/Aqua applicability; all utility `products` lists match their source declarations.
- All 12 image paths referenced by the complete Markdown manual currently resolve under `images/`; images remain outside the Markdown-only line-location digest.
- Final `INDEX.md` SHA-256: `8C5548E1AC6BE2A0A704A9AD15F532510F67E47D64810683DED96CCE93C155BE`.
- `python scripts/validate_workspace.py`: passed; reference artifact validation succeeded and no Fortran validation commands were configured in the current working tree.
- `python -m unittest discover -s scripts -p "test_*.py"`: 26 tests ran; 23 passed and 3 pre-existing UEL wrapper tests failed because `src/fortran/uel_3d_euler_beam_uel.for` is currently deleted in the user's working tree.
- `git diff --cached --check`: passed for the staged manual-index changes. Repository-wide `git diff --check` remains blocked by a pre-existing extra blank line at `AGENTS.md:110`.
Latest verification after correcting the Abaqus-facing UEL wrapper/interface:
```bash