> For the complete documentation index, see [llms.txt](https://docs.openbrim.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.openbrim.org/developers/llm-guides.md). # LLM Guides This section contains documentation specifically designed for Large Language Models (LLMs) to understand and work with ParamML and the OpenBrIM platform. These guides provide structured context that helps AI assistants generate accurate ParamML code, understand the platform's capabilities, and assist developers with engineering workflows. ## Contents ### Core Documentation * **ParamML README** - Overview of ParamML language and syntax * **Core Objects** - Reference for core ParamML object types * **Component Instances** - Working with component instances * **Export** - Exporting data and models * **Extends** - Object inheritance and extension patterns * **ParamML Functions Reference** - Complete function reference ### Feature Guides * **Parametric Engine Guide** - Understanding the parametric engine * **3D Visualization Guide** - Creating 3D visualizations * **Bridge Alignment Guide** - Working with bridge alignments * **Bridge Workflow Generation Guide** - Generating bridge workflows * **CADD Drawing Guide** - Creating CAD drawings * **Document Generation Guide** - Generating documents * **FEA Guide** - Finite Element Analysis setup * **FEA Results Guide** - Working with FEA results --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.openbrim.org/developers/llm-guides.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.