added updated docs #503
Open
added updated docs #503
Conversation
This file contains 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
jonchang
reviewed
Jan 10, 2025
| @@ -19,8 +19,9 @@ | |||
|
|
|||
| ## Overview | |||
|
|
|||
| Describe the purpose of your project. Add additional sections as necessary to help collaborators and potential collaborators understand and use your project. | |||
|
|
|||
| Please see the User Guide to get a overview of this project. | |||
There was a problem hiding this comment.
Would be good to include the link to this
There was a problem hiding this comment.
you can use mermaid.js to create this if you don't want to embed a png-
https://github.blog/developer-skills/github/include-diagrams-markdown-files-mermaid/
|
|
||
| #### Health Check | ||
| - **`GET /`** | ||
| - **Description**: Returns the status of the OCR service. |
There was a problem hiding this comment.
Are we also doing swagger type docs as well?
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.
Description
Create Document Artifacts no code changes
Related Issues
Checklist