Skip to content
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

Large Code Examples in Documentation #277

Open
4 tasks
brian-comply0 opened this issue Jan 6, 2023 · 3 comments
Open
4 tasks

Large Code Examples in Documentation #277

brian-comply0 opened this issue Jan 6, 2023 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@brian-comply0
Copy link

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:

  • 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)
@brian-comply0 brian-comply0 added the enhancement New feature or request label Jan 6, 2023
@github-actions github-actions bot added this to Needs Triage in Issue Triage Jan 6, 2023
@aj-stein-nist aj-stein-nist moved this from Needs Triage to Needs Discussion in Issue Triage Jan 10, 2023
@aj-stein-nist
Copy link
Collaborator

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.

@wendellpiez
Copy link
Collaborator

When to do this also depends on level of effort.

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.

@aj-stein-nist aj-stein-nist moved this from Needs Discussion to Allocated to Milestone in Issue Triage Jan 12, 2023
@aj-stein-nist
Copy link
Collaborator

Removing OSCAL work board per discussion with @david-waltermire-nist.

@david-waltermire david-waltermire added the documentation Improvements or additions to documentation label Jun 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
No open projects
Issue Triage
Allocated to Milestone
Development

No branches or pull requests

4 participants