You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
As a Metaschema author, I want large code examples in the documentation to be confined to a maximum allowable vertical space, while still having access to the entire code example.
In working this issue, the maximum allowed vertical space should be established and universally set.
There are different methods for enabling the user to view the rest of the example code that doesn't fit within the vertical limits, such as scroll bars or expandable boxes. The best method should be identified and universally used for all code examples that exceed the established vertical limit.
Goals:
Enable the provision of larger code examples, while simultaneously preventing them from overwhelming the overall content.
Dependencies:
Not dependent on other issues
Acceptance Criteria
All website and readme documentation affected by the changes in this issue have been updated. Changes to the website can be made in the docs/content directory of your branch.
A Pull Request (PR) is submitted that fully addresses the goals of this User Story. This issue is referenced in the PR.
The CI-CD build process runs without any reported errors on the PR. This can be confirmed by reviewing that all checks have passed in the PR.
Examples code is constrained to a maximum allowed vertical space, while still enabling users to view the entire code example. (see comments)
The text was updated successfully, but these errors were encountered:
I opened an issue in usnistgov/hugo-uswds but I think we need to queue this up for discussion with @david-waltermire-nist as to urgency and importance.
However, if we clarify a means -- and Hugo will pass through an explicitly tagged div with a class, providing a hook for a CSS extension, so that would be one way (short of a Hugo extension) -- probably this can be done easily enough.
User Story:
As a Metaschema author, I want large code examples in the documentation to be confined to a maximum allowable vertical space, while still having access to the entire code example.
In working this issue, the maximum allowed vertical space should be established and universally set.
There are different methods for enabling the user to view the rest of the example code that doesn't fit within the vertical limits, such as scroll bars or expandable boxes. The best method should be identified and universally used for all code examples that exceed the established vertical limit.
Goals:
Enable the provision of larger code examples, while simultaneously preventing them from overwhelming the overall content.
Dependencies:
Acceptance Criteria
The text was updated successfully, but these errors were encountered: