Docs: restructure into Diataxis-style docs and align examples with current behavior#28
Open
d-lazenby wants to merge 1 commit into
Open
Docs: restructure into Diataxis-style docs and align examples with current behavior#28d-lazenby wants to merge 1 commit into
d-lazenby wants to merge 1 commit into
Conversation
Contributor
There was a problem hiding this comment.
NIT: Minor formatting inconsistency
Requirement types should follow a consistent format.
At the moment, some are defined as:
`name` (required, string)
Others are defined as:
`glob` (string)
And some include defaults:
`pin` (string, default: `"sha"`)
Consider standardising all definitions to the same structure, e.g.:
`field` (required|optional, type, default: value)
This keeps things consistent across:
- required/optional
- type
- default value (where applicable)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
This PR overhauls the project documentation to be clearer for end users while keeping it concise and navigable.
Closes #26
What changed
Why
Scope and impact
Validation