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.

Sign up for GitHub

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

Jump to bottom

docs: simplify README and move details to docs #102

Merged
merged 4 commits into from
Mar 17, 2025
Merged

docs: simplify README and move details to docs #102

merged 4 commits into from
Mar 17, 2025

Conversation

dolfim-ibm
Copy link
Contributor

@dolfim-ibm dolfim-ibm commented Mar 16, 2025 •
edited
Loading

  • Simplify README
  • Document container images
  • Details in ./docs/
  • Document all uvicorn and docling-serve configuration arguments
  • Add deployment example
  • Document async endpoints and websocket

@mergify Mergify
Copy link

mergify bot commented Mar 16, 2025

Merge Protections

Your pull request matches the following merge protections and will not be merged until they are valid.

🟢 Enforce conventional commit

Wonderful, this rule succeeded.

Make sure that we follow https://www.conventionalcommits.org/en/v1.0.0/

  • title ~= ^(fix|feat|docs|style|refactor|perf|test|build|ci|chore|revert)(?:\(.+\))?(!)?:

@dolfim-ibm
fix linter
743ebf7 
Signed-off-by: Michele Dolfi <[email protected]>
@dolfim-ibm
fix local md-lint
ed369d9 
Signed-off-by: Michele Dolfi <[email protected]>
@dolfim-ibm
add configuration
b5dfc8b 
Signed-off-by: Michele Dolfi <[email protected]>
@dolfim-ibm dolfim-ibm marked this pull request as ready for review March 17, 2025 11:38
@dolfim-ibm dolfim-ibm requested a review from vku-ibm March 17, 2025 11:39
@dolfim-ibm dolfim-ibm merged commit fd8e40a into main Mar 17, 2025
9 checks passed
@dolfim-ibm dolfim-ibm deleted the docs-simplify-readme branch March 17, 2025 12:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vku-ibm vku-ibm vku-ibm approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@dolfim-ibm @vku-ibm