Point the agent docs at opt-solve and opt-trade, and record three traps - #64
Merged
Merged
Conversation
raorjun
added this pull request to stack #65
September 21, 2026 03:25
raorjun
marked this pull request as ready for review
September 21, 2026 03:31
raorjun
force-pushed
the
docs/optsim-agent-docs
branch
from
September 21, 2026 03:47
410dcd3 to
5f39c91
Compare
raorjun
force-pushed
the
docs/optsim-agent-docs
branch
3 times, most recently
from
September 24, 2026 01:30
223cc83 to
3f86708
Compare
The routing table and the docs index still described OptSim as sweeps plus a reverse lookup. So an agent asked to size a bar or compare two options would go to the wrong tool. They now name all three tools and say which question each one answers. Three traps cost real time during this work. They are now under common mistakes: - OpenModelica accepts an override of toe, camber or any mass value, and the override silently does nothing. - A consumer must not rewrite the sweep's committed _doe_config.yaml. It records the scope that opt-search needs. - Git Bash on Windows rewrites the /workspace paths that make passes to Docker.
raorjun
force-pushed
the
docs/optsim-agent-docs
branch
from
September 24, 2026 01:32
3f86708 to
51987bd
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
This PR updates BobSim's agent docs for the OptSim work in #59, #61 and #63. Stacked on #63. Docs only.
The routing table in
AGENTS.mdanddocs/README.mdstill described OptSim as sweeps plus a reverse lookup. So an agent asked to size a bar or compare two options would go to the wrong tool. They now name all three tools (opt-standard,opt-solve,opt-trade) and say which question each one answers.docs/workflows.mdlists the two new targets and where they cache.docs/architecture.mdnames the two modules that the solver and the trade study share.This PR adds three entries under Common agent mistakes. Each one cost real time during work on those PRs.
-overridecan be accepted and do nothing. OpenModelica evaluates toe, camber and every mass and CG value at compile time. The parameter still reportsisValueChangeable="true", and the runner gives no warning. Only the paths inRUNTIME_SAFE_PATHSare proven to follow an override.VariantStore. It must not rewrite the sweep's committed_doe_config.yaml, which records the scope thatopt-searchneeds./workspace/...becomesC:/Program Files/Git/workspace/..., and the run stops in seconds.MSYS_NO_PATHCONV=1fixes it.How to check
Read the four files. This PR has no code.
python -m pytest tests -qgives the same result as on #63, because no test checks doc contents. The claims are the ones that #61 and #63 proved by experiment, and the docs link to them.Notes
The change is small on purpose.
AGENTS.mdhas its own rule that a stale doc is worse than no doc. This PR adds no new doc file, so neither docs table needed a new row. The full explanation stays indocs/doe-reverse-engineering.md. These entries are pointers and traps.Merge after #63. The OptSim page on the public site is updated separately in BobDyn/BobDocs.