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

Update Vignette #33

Open
5 tasks
zkamvar opened this issue Aug 6, 2024 · 0 comments
Open
5 tasks

Update Vignette #33

zkamvar opened this issue Aug 6, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@zkamvar
Copy link
Member

zkamvar commented Aug 6, 2024

  • add mention of model-metadata.json in Configure Modeling Hub.
    • add mention of model-metadata to validate_config()
    • add mention of model-metadata to validate_hub_config()
  • swap sections for validate_config() and validate_hub_config().
    • Rationale: people are generally going to be skimming this document, so quick wins presented first (top-down) are going to be more valuable than a bottom-up approach by explaining the components first.
  • demonstrate view_config_val_errors() on output from validate_hub_config().
    • Rationale: The sentence "You can also use view_config_val_errors() on the output of validate_hub_config() to review any detected validation errors." occurs at the very end of the vignette and I've already checked out by the time I get there. I did not know that I could do that until Anna told me.

Note: this will also benefit from #32

@zkamvar zkamvar added the documentation Improvements or additions to documentation label Aug 6, 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