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

Demonstrate how to validate manifests #38

Open
alice-i-cecile opened this issue Apr 17, 2024 · 0 comments
Open

Demonstrate how to validate manifests #38

alice-i-cecile opened this issue Apr 17, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@alice-i-cecile
Copy link
Contributor

What problem did the developer encounter?

Ensuring that manifests are valid is an incredibly important quality control step.

Doing so is currently left to the user's imagination however.
This is particularly important when dependent manifests are used: dead links are common and will cause subtle failures.

Types help a lot, but other errors could exist!

How could this be better documented?

  1. Showcase how to load all manifests in a test, and assert that they load correctly.
  2. Demonstrate how to perform bounds-checking on field values.
  3. Demonstrate how to validate that all IDs to entries in other manifests are valid.
  4. Demonstrate how to check that all assets are used by an entry in a manifest.
  5. Demonstrate how to check that all other required assets can be loaded.
@alice-i-cecile alice-i-cecile added the documentation Improvements or additions to documentation label Apr 17, 2024
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
Projects
None yet
Development

No branches or pull requests

1 participant