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 documentation to include code snippet examples for using the validator as a library #1619

Closed
emmambd opened this issue Nov 30, 2023 · 1 comment · Fixed by #1635
Closed
Assignees
Labels
documentation Anything related to our documentation

Comments

@emmambd
Copy link
Contributor

emmambd commented Nov 30, 2023

Describe the problem

Now that we're publishing the validator on Maven as a library (#1588), the community needs examples for how to implement it this way.

Suggest a fix or an alternative

  • Provide code snippet examples for how to use the validator as a library in the README.
  • Create example project to showcase how to integrate Maven library
@emmambd emmambd added documentation Anything related to our documentation status: Needs triage Applied to all new issues status: Ready An issue that is ready to be worked on. and removed status: Needs triage Applied to all new issues labels Nov 30, 2023
@davidgamez
Copy link
Member

davidgamez commented Dec 4, 2023

Tasks:

  • Create an example project with minimum functionality
  • Create documentation and code snippet.
  • Share documentation

@emmambd emmambd moved this to MobilityData Backlog (bugs & maintenance) in Schedule Validator Q2 backlog Dec 4, 2023
@emmambd emmambd added this to the Now milestone Jan 9, 2024
@github-project-automation github-project-automation bot moved this from MobilityData Backlog (bugs & maintenance) to Done in Schedule Validator Q2 backlog Jan 9, 2024
@emmambd emmambd removed the status: Ready An issue that is ready to be worked on. label Jan 9, 2024
@emmambd emmambd removed this from the Now milestone Mar 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Anything related to our documentation
Projects
3 participants