#635 Add documentation for executability #1507
Conversation
RamilCDISC
left a comment
RamilCDISC
left a comment
There was a problem hiding this comment.
I ran the editor locally with schema url pointing to core-base.json of this branch, when i hover over executability, documentation appears but the heading where all options are supposed to be visible is empty and shows only pipe symbols. Please see the attached screenshot. Please let me know i have missed something in local execution.
resources/schema/Executability.md
Outdated
| @@ -0,0 +1,35 @@ | |||
| ## Executability | |||
There was a problem hiding this comment.
Could you please make its size heading 1, for consistency with pattern of other documentation.
There was a problem hiding this comment.
I changed from markdownDescription to title for individual enum values and I think it should resolve the || issue, and also I updated the heading size. If you run into any issues, please let me know.
…com/cdisc-org/cdisc-rules-engine into 635-Documentation-for-Executability
…nDescription for enum values
RamilCDISC
left a comment
RamilCDISC
left a comment
There was a problem hiding this comment.
The PR adds documentation for executability key in rule yaml. The changes were validated by:
- Reviewing the PR code for any unwanted changes or comment.
- Reviewing the PR logic in accordance with AC.
- Ensuring all testing pass.
- Running manual testing using local editor.
- Confirming intellisense shows all option for executability.
- Confirming hovering shows correct details and help for executability.
- Ensuring this documentation does not break execution of rule in any way.
Issue #635 : Add documentation for Executability
Adds Executability documentation. Updates CORE-base.json to convert the Executability field from a simple enum to an anyOf pattern with markdownDescription for each option (Fully Executable, Not Executable, Partially Executable, Partially Executable - Possible Overreporting, Partially Executable - Possible Underreporting), enabling intellisense descriptions in the rule editor. Creates Executability.md in resources/schema/ with documentation for all Executability options, including examples and notes that Executability is informational metadata. Updates conformance-rules-editor/docs/executability.md to use the include pattern, pulling content from the cdisc-rules-engine repo to match the pattern used by other schema documentation files.