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

Syntax Documentation Improvements #15

Closed
3 tasks
Tracked by #17
brian-ruf opened this issue Dec 17, 2020 · 1 comment
Closed
3 tasks
Tracked by #17

Syntax Documentation Improvements #15

brian-ruf opened this issue Dec 17, 2020 · 1 comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request scope: documentation generation

Comments

@brian-ruf
Copy link

User Story:

As an OSCAL implementer, when reviewing the OSCAL syntax documents it would be helpful to have a summary of flags, fields, and assemblies first (as they appeared in the original version of the generated documentation), then followed by the expanded view as it appears now. This is especially important with larger assemblies. It is currently very difficult to find fields farther down in the assembly.

It would also be helpful to have improved visual delimiters as to where flags end and fields/sub-assemblies begin, as well as where the top-level assembly ends.

Goals:

  • Increase usability by enabling a summary view of an assembly before the expanded view
  • Provider better visual delimiters as to where one assembly ends and another begins, as well as within the assembly to differentiate flags from fields/sub-assemblies, and to further differentiate the child syntax of sub-assemblies.

Dependencies:

None.

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.
@wendellpiez
Copy link
Collaborator

wendellpiez commented Feb 14, 2023

Raises of how to address documentation enhancement improvement issues -- this might actually better be handled by OSCAL team since its scope is OSCAL documentation.

This Issue is flagged 'documentation' but it's not about Metaschema documentation, it is about XSLT M4 documentation generation. Maybe we need a flag for that?

@david-waltermire david-waltermire transferred this issue from usnistgov/metaschema Jun 30, 2023
JustKuzya added a commit to JustKuzya/metaschema-xslt that referenced this issue Aug 25, 2023
… To point to original Metaschema types much bigger refactoring would be needed!
JustKuzya added a commit to JustKuzya/metaschema-xslt that referenced this issue Sep 7, 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 scope: documentation generation
Projects
None yet
Development

No branches or pull requests

2 participants