-
Notifications
You must be signed in to change notification settings - Fork 27
#635 Add documentation for executability #1507
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
RamilCDISC
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
| @@ -0,0 +1,35 @@ | |||
| ## Executability | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could you please make its size heading 1, for consistency with pattern of other documentation.
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.