Skip to content

Refresh README, branding, and self-hosting guidance - #580

Merged
CyMule merged 3 commits into
mainfrom
docs/refresh-readme-and-branding
Jul 21, 2026
Merged

Refresh README, branding, and self-hosting guidance#580
CyMule merged 3 commits into
mainfrom
docs/refresh-readme-and-branding

Conversation

@CyMule

@CyMule CyMule commented Jul 20, 2026

Copy link
Copy Markdown
Contributor

Summary

  • replace the outdated Unstructured.io logo with the current stacked wordmark
  • remove unused legacy raster branding assets
  • rewrite the README around the self-hosted Partition Endpoint
  • remove stale launch, Chipper beta, Phorm, and hosted API content
  • update Python, uv, Docker, API, security, and configuration guidance
  • correct outdated examples, defaults, links, and container registry references
  • clarify graceful shutdown behavior and PDF parallel-processing options
  • point managed API users to the current Unstructured documentation

Why

The README had accumulated launch-era product copy, retired branding, obsolete commands and endpoints, and guidance that no longer matched the repository's runtime configuration. That made it difficult to distinguish this self-hosted service from the current managed API and could send users toward incorrect setup and deployment paths.

Impact

Users now get a shorter self-hosting guide aligned with the current codebase, current documentation, and current container publishing workflow. The API implementation is unchanged.

Test plan

  • validated the new SVG with xmllint
  • checked the README's Bash examples with bash -n
  • verified every external README link returns successfully
  • ran git diff --check
  • application tests not run because the changes only affect documentation and image assets

Review in cubic

@CyMule
CyMule marked this pull request as ready for review July 20, 2026 18:27

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

All reported issues were addressed across 4 files

Shadow auto-approve: would not auto-approve because issues were found.

Re-trigger cubic

Comment thread README.md Outdated
Comment thread README.md Outdated
CyMule and others added 2 commits July 20, 2026 19:28
Co-authored-by: cragwolfe <crag@unstructured.io>

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

0 issues found across 1 file (changes from recent commits).

Shadow auto-approve: would auto-approve. Replaces outdated branding, removes legacy assets, and rewrites README for the self-hosted partition endpoint. Documentation-only changes with no behavioral impact.

Re-trigger cubic

@paulkarayan paulkarayan left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

lgtm

@CyMule
CyMule merged commit 04fe194 into main Jul 21, 2026
13 checks passed
@CyMule
CyMule deleted the docs/refresh-readme-and-branding branch July 21, 2026 15:59
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.

3 participants