feat(docs): add relevant links to project documentation #15
Conversation
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
hoangsonww
added
documentation
There was a problem hiding this comment.
Pull Request Overview
This PR enhances the project’s README by adding key links for easier developer onboarding and refining note formatting.
- Added a “Live Website” link at the top of the README
- Inserted a “Frontend Repository” note with a direct link
- Updated an existing note’s label from
[!NOTE]to[!IMPORTANT]
Comments suppressed due to low confidence (2)
README.md:32
- The
[!NOTE]admonition syntax is not supported in standard GitHub Markdown. Consider using a GitHub-supported format like a blockquote with a heading (e.g., '### Note:') or a custom component for admonitions to ensure proper rendering.
> [!NOTE]
README.md:91
- [nitpick] This admonition uses
[!IMPORTANT], which differs from the earlier[!NOTE]block. For consistency and clarity, standardize on one admonition style or format that is supported by your rendering system.
> [!IMPORTANT]
|
|
||
| AugMed is a web application, built for the UNC-Chapel Hill DHEP Lab, that allows the lab to collect data from participants in a user-friendly way. The app is designed to be used on any devices, and it allows participants to answer questions about their judgements for cases with potential Colorectal Cancer (CRC). The app is built using React, and the backend API is built using Flask and Python. | ||
|
|
||
| **Live Website**: **[https://augmed1.dhep.org/](https://augmed1.dhep.org/).** |
There was a problem hiding this comment.
[nitpick] The period at the end of the link is inside the bold syntax, which may render inconsistently. Consider moving the period outside the closing ** so the link text is not bolded with the punctuation.
Suggested change
| **Live Website**: **[https://augmed1.dhep.org/](https://augmed1.dhep.org/).** | |
| **Live Website**: **[https://augmed1.dhep.org/](https://augmed1.dhep.org/)**. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
SUMMARY
This PR is a small one that builds on top of #14. It adds relevant links and documentation to help developer onboarding easier.
Pre-merge author checklist