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

Feature improve documentation #329

Merged
merged 43 commits into from
Jun 2, 2023

Conversation

david-waltermire
Copy link
Collaborator

@david-waltermire david-waltermire commented Mar 9, 2023

Committer Notes

This PR represents Metaschema specification improvements made during a full review and edit of the current Metaschema specification.

This PR will address the following issues:

Also addressed:

  • Fixed a bug in the base64 data type causing values in the range g-z and +/= to not be valid.

All Submissions:

  • Have you followed the guidelines in our Contributing document?
  • Have you checked to ensure there aren't other open Pull Requests for the same update/change?
  • Have you squashed any non-relevant commits and commit messages? [instructions]
  • Do all automated CI/CD checks pass?

Changes to Core Features:

  • Have you added an explanation of what your changes do and why you'd like us to include them?
  • Have you written new tests for your core changes, as applicable?
  • Have you included examples of how to use your new feature(s)?
  • Have you updated all website](https://pages.nist.gov/metaschema) and readme documentation affected by the changes you made? Changes to the website can be made in the website/content directory of your branch.

Copy link
Collaborator

@wendellpiez wendellpiez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Still working on it ...

website/content/specification/_index.md Outdated Show resolved Hide resolved
website/content/specification/_index.md Outdated Show resolved Hide resolved
website/content/specification/_index.md Outdated Show resolved Hide resolved
website/content/specification/_index.md Outdated Show resolved Hide resolved
website/content/specification/_index.md Outdated Show resolved Hide resolved
website/content/specification/_index.md Outdated Show resolved Hide resolved
website/content/specification/_index.md Outdated Show resolved Hide resolved
website/content/specification/_index.md Outdated Show resolved Hide resolved
website/content/specification/_index.md Outdated Show resolved Hide resolved
website/content/specification/_index.md Outdated Show resolved Hide resolved
wendellpiez
wendellpiez previously approved these changes Apr 18, 2023
Copy link
Collaborator

@wendellpiez wendellpiez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking good!

website/content/specification/_index.md Outdated Show resolved Hide resolved
website/content/specification/terminology.md Outdated Show resolved Hide resolved
website/content/specification/terminology.md Outdated Show resolved Hide resolved
website/content/specification/terminology.md Outdated Show resolved Hide resolved
website/content/use/_index.md Show resolved Hide resolved
website/content/use/_index.md Outdated Show resolved Hide resolved
@nikitawootten-nist
Copy link
Contributor

NB: I've found the right navigation sidebar to be pretty useless for the specification page:
image

There are too many headings to meaningfully navigate. Could the sidebar generator be adjusted to only generate entries up to a certain depth (ignore h3 and below)? Otherwise the page may be better served if the sidebar was disabled.

wendellpiez
wendellpiez previously approved these changes May 19, 2023
Copy link
Collaborator

@wendellpiez wendellpiez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall I didn't see much and some require judgement but perhaps not action.

Nice job!

aj-stein-nist
aj-stein-nist previously approved these changes Jun 2, 2023
Copy link
Collaborator

@aj-stein-nist aj-stein-nist left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I found minor types or recommendations on possible stylistic improvement, but those are not important and for the most part subjective. Excellent work, I look forward to finish constraint docs, others areas, and applying what I have learned overall from these docs and put them to good use.

website/content/tutorials/1-getting-started/_index.md Outdated Show resolved Hide resolved
build/go.mod Show resolved Hide resolved
schema/xml/metaschema-datatypes.xsd Outdated Show resolved Hide resolved
schema/xml/metaschema-datatypes.xsd Outdated Show resolved Hide resolved
website/content/specification/glossary.md Outdated Show resolved Hide resolved
website/content/tutorials/1-getting-started/_index.md Outdated Show resolved Hide resolved
website/content/tutorials/1-getting-started/_index.md Outdated Show resolved Hide resolved
website/content/use/_index.md Outdated Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
4 participants