Skip to content

docs: update deprecated architecture information#1694

Merged
emmambd merged 2 commits intoMobilityData:masterfrom
michaelandrewkearney:annotation-docs
Mar 13, 2024
Merged

docs: update deprecated architecture information#1694
emmambd merged 2 commits intoMobilityData:masterfrom
michaelandrewkearney:annotation-docs

Conversation

@michaelandrewkearney
Copy link
Copy Markdown

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!

@ghost ghost force-pushed the annotation-docs branch 2 times, most recently from ffceee7 to 0aae332 Compare March 7, 2024 04:09
@michaelandrewkearney
Copy link
Copy Markdown
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
Copy Markdown
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
@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