doc: fix some grammar errors and refine some expressions #21
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In this PR, I've made the following changes:
grammar fixes:
removed the "The model specification needs to consider two factors" part.
I don't think design considerations/motivations should be included in the specification document itself (but rather in a separate place such as README.md).
I've transformed this information into a "Use Case" section, similar to the arrangement in the OCI Distribution Spec.
reordered the "Workflow" and "Spec Definition" sections:
I think it's better to introduce the spec itself before discussing the workflow.
clarified the distinction between Model Format Spec and Manifest Spec:
Several parts of the document blurred the distinction between these two concepts. For example,
I attempted to explicitly differentiate them, as they represent concepts at different levels. For example,
removed redundancies:
Several parts of the document repeat the same information, For example,
regarding
artifactType
andannotations
properties:Now only mentioned once:
regarding compression:
Now consolidated as an implementers note, aligning with the writing conventions used in the OCI Image Specification.
added "REQUIRED" or "OPTIONAL" to all properties
mediaType
where it was missing.annotations
where it was missing.