Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

added updated docs #503

Merged
merged 13 commits into from
Jan 14, 2025
Merged

added updated docs #503

merged 13 commits into from
Jan 14, 2025

Conversation

arinkulshi-skylight
Copy link
Collaborator

Description

Create Document Artifacts no code changes

Related Issues

Checklist

  • The title of this PR is descriptive and concise.
  • My changes follow the style guidelines of this project.
  • I have added or updated test cases to cover my changes.
  • I've let the team know about this PR by linking it in the review channel

Sorry, something went wrong.

@arinkulshi-skylight arinkulshi-skylight marked this pull request as draft January 7, 2025 19:38
@arinkulshi-skylight arinkulshi-skylight marked this pull request as ready for review January 9, 2025 19:57
README.md Outdated
@@ -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.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would be good to include the link to this

arcdiagram.png Outdated
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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/

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great Idea! I have added that let me know if I should make some adjustments to the formatting.


#### Health Check
- **`GET /`**
- **Description**: Returns the status of the OCR service.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are we also doing swagger type docs as well?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point I will add the link here.

@arinkulshi-skylight arinkulshi-skylight added this pull request to the merge queue Jan 14, 2025
Merged via the queue into main with commit 626cce4 Jan 14, 2025
5 checks passed
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.

None yet

3 participants