feat(docs): enhance docs with GitHub flavors markdown#16
Merged
Conversation
Signed-off-by: Son Nguyen <hoangson091104@gmail.com>
hoangsonww
added
documentation
✅ Deploy Preview for ai-classifiers canceled.
|
There was a problem hiding this comment.
Pull Request Overview
This PR enhances the documentation by adopting GitHub-flavored markdown with custom admonition blocks for notes, tips, cautions, and important instructions. The changes update the formatting for download links, deployment details, classifier usage, and Docker instructions.
Comments suppressed due to low confidence (4)
README.md:126
- Verify that the custom admonition syntax ([!IMPORTANT]) is fully supported by your target markdown renderer. If there is a risk of unsupported rendering, consider adding a note or fallback styling in the documentation.
> [!IMPORTANT]
README.md:177
- Ensure that the [!NOTE] admonition block for the Heroku deployment message renders consistently across all documentation views. Confirm compatibility with your markdown processor.
> [!NOTE]
README.md:649
- Check that the use of [!CAUTION] for the sentiment classifier instructions is rendered as intended in your documentation environment. Consistent styling for admonitions helps maintain clarity.
> [!CAUTION]
README.md:698
- Confirm that the [!IMPORTANT] block for Docker installation guidance displays correctly across different markdown renderers. This ensures that key setup instructions are not overlooked.
> [!IMPORTANT]
Signed-off-by: Son Nguyen <hoangson091104@gmail.com>
Signed-off-by: Son Nguyen <hoangson091104@gmail.com>
Signed-off-by: Son Nguyen <hoangson091104@gmail.com>
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
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.
No description provided.