Updated readme to include architecture diagram#113
Merged
Conversation
Added architecture section with an image and description, i.e., pointer to local concept mapping service
Added citation information for the project to the README.
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Code Review
This pull request updates the README.md by adding a citation section, an architecture overview with a diagram, and updating external links. Feedback was provided to improve the accessibility of the newly added architecture diagram by using a descriptive alt text instead of a raw filename.
| The figure below illustrates the overall architecture of **StructSense**. | ||
|
|
||
|
|
||
| <img width="2571" height="823" alt="with_arch_search-with_search_api drawio (1)" src="https://github.com/user-attachments/assets/8f652c10-4301-4193-b1c8-f750229f972c" /> |
Contributor
There was a problem hiding this comment.
The alt text for the architecture diagram is currently a raw filename. Using a descriptive title like "StructSense Architecture Diagram" improves accessibility for users with screen readers and provides better context if the image fails to load.
Suggested change
| <img width="2571" height="823" alt="with_arch_search-with_search_api drawio (1)" src="https://github.com/user-attachments/assets/8f652c10-4301-4193-b1c8-f750229f972c" /> | |
| <img width="2571" height="823" alt="StructSense Architecture Diagram" src="https://github.com/user-attachments/assets/8f652c10-4301-4193-b1c8-f750229f972c" /> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR updates readme, adds architecture diagram, references to pre-print.