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

docs: update deprecated architecture information #1694

Merged
merged 2 commits into from
Mar 13, 2024

Conversation

michaelandrewkearney
Copy link
Contributor

Summary:

Updates documentation of the architecture to correct errors, reflect changes to generated class names, and include new annotations.

Expected behavior:

  • The "Main" section accurately reflects the validator architecture.
  • The "Generated Classes" section of main includes all generated classes.
  • The "Adding new tables and fields" section instructions are more specific.
  • "Annotation Definitions" table includes all annotations.
  • All links direct to the appropriate file or folder.

In lieu of screenshots, see rich diff of architecture.md.

Please make sure these boxes are checked before submitting your pull request - thanks!

  • Run the unit tests with gradle test to make sure you didn't break anything
  • Add or update any needed documentation to the repo
  • Format the title like "feat: [new feature short description]". Title must follow the Conventional Commit Specification(https://www.conventionalcommits.org/en/v1.0.0/).
  • Linked all relevant issues
  • Include screenshot(s) showing how this pull request works and fixes the issue(s)

@michaelandrewkearney
Copy link
Contributor Author

Realized this may resolve #1645, although not in an automated way.

@emmambd emmambd linked an issue Mar 7, 2024 that may be closed by this pull request
Copy link
Member

@davidgamez davidgamez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@emmambd emmambd requested a review from jcpitre March 12, 2024 21:51
@emmambd emmambd merged commit 86bc9cc into MobilityData:master Mar 13, 2024
14 checks passed
@michaelandrewkearney michaelandrewkearney deleted the annotation-docs branch March 14, 2024 20:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update ARCHITECTURE.md with the list of all Java anotations
3 participants