Update documentation to reflect updated code.#40
Merged
Conversation
- Remove completed plan (simulator-symbol-alignment.md) - Remove redundant terminal-definitions.md (content covered in terminal-yaml-definitions.md) - Move api-decoupling.md to decisions/0003-api-decoupling-analysis.md - Update README.md with actual project description - Update todo.md to be more concise - Add font sizing to all Mermaid diagrams - Create documentation-plan.md with todos and agent prompts - Fix all broken cross-references Co-authored-by: gilesknap <964827+gilesknap@users.noreply.github.com>
Co-authored-by: gilesknap <964827+gilesknap@users.noreply.github.com>
- Update use-terminal-editor.md Architecture section with correct module names - Fix xml_parser.py reference in beckhoff-xml-format.md to xml/parser.py - Fix xml_pdo_groups.py reference in dynamic-pdos.md to xml/pdo_groups.py - Fix AGENTS.md references to xml parsing modules Co-authored-by: gilesknap <964827+gilesknap@users.noreply.github.com>
- Fix "Adding a Terminal" section: search is live/automatic (no Search button) - Document filtering by type dropdown functionality - Document "Add All" button for bulk terminal addition - Improve troubleshooting section with correct cache update command Co-authored-by: gilesknap <964827+gilesknap@users.noreply.github.com>
Remove %%{init: ...fontSize...}%% directives that were causing oversized fonts.
Let mermaid use default font sizing for consistent appearance.
Co-authored-by: gilesknap <964827+gilesknap@users.noreply.github.com>
- Added composite_types section documentation - Updated file organization (single terminal_types.yaml, not multiple files) - Added 'selected' field to symbol nodes documentation - Added full CoE objects with subindices documentation - Updated examples to match actual YAML from src/catio_terminals/terminals/ - Changed fastcs_name convention from PascalCase to snake_case to match actual files Co-authored-by: gilesknap <964827+gilesknap@users.noreply.github.com>
…tion - Added Terminal Definitions subgraph showing YAML-driven controller generation - Added Dynamic Controller Generation section explaining catio_dynamic_*.py modules - Updated High-Level Architecture Diagram to show dynamic terminal controllers - Updated file references (catio_hardware.py → catio_dynamic_*.py) - Updated Controller Hierarchy to show DynamicELxxxxController naming - Added link to terminal-yaml-definitions.md in See Also Co-authored-by: gilesknap <964827+gilesknap@users.noreply.github.com>
- Replaced "Hardware-Specific Controllers" section with "Dynamic Terminal Controllers" - Removed references to catio_hardware.py and explicit controller classes (EL10xxController, etc.) - Added documentation for get_terminal_controller_class() factory function - Documented the catio_dynamic_*.py modules and their roles - Added link to terminal-yaml-definitions.md for YAML format details Co-authored-by: gilesknap <964827+gilesknap@users.noreply.github.com>
…class - Added mermaid-simple CSS class that uses natural diagram size instead of 100% width - Wrapped Runtime Data Flow diagram in mermaid-simple div to prevent oversized fonts - Complex diagrams still use full width, simple diagrams use natural size Co-authored-by: gilesknap <964827+gilesknap@users.noreply.github.com>
- Replaced literalinclude directives with brief descriptions and links to source files - Updated fastcs-epics-ioc.md: CATioController, CATioControllerAttributeIO, MockADSServer - Updated ads-client.md: RemoteRoute, AsyncioADSClient, AdsSymbol, MockADSServer - Follows AGENTS.md guideline to never embed code from the repository Co-authored-by: gilesknap <964827+gilesknap@users.noreply.github.com>
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
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.
switching merge branch to main. Details of this pr are here #39