Rewrite README.md based on approved Confluence spec#1795
Merged
hari-kuriakose merged 14 commits intomainfrom Mar 1, 2026
Merged
Rewrite README.md based on approved Confluence spec#1795hari-kuriakose merged 14 commits intomainfrom
hari-kuriakose merged 14 commits intomainfrom
Conversation
Rewrites the GitHub README following the marketing team's "GitHub Content - Spec" from Confluence, with Hari's two corrections applied: - Architecture diagram shows Cache (Redis) and Message Queue (RabbitMQ) as separate rows - ENCRYPTION_KEY backup warning moved to its own section under "Other Deployment Options" Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Contributor
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
WalkthroughREADME.md fully rewritten: title and hero updated, badges removed/placeholdered, "Prompt Studio" replaced by "What is Unstract?", visuals and integrations consolidated, quickstart and deployment instructions added (local/Docker), connectors simplified into status lists, backup-encryption and architecture sections introduced, and content refocused toward developer/deployment guidance. (48 words) Changes
Estimated code review effort🎯 4 (Complex) | ⏱️ ~45 minutes 🚥 Pre-merge checks | ✅ 4✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 4
🤖 Fix all issues with AI agents
In `@README.md`:
- Line 207: The Use Cases links in the README ("Finance & Banking", "Insurance",
"Healthcare", "Income Tax") currently point to placeholder "#" which causes
markdownlint failures and broken navigation; update each anchor to a real URL if
the pages exist or remove the markdown link syntax (leave plain text) for those
four items so the links are no longer empty placeholders and lint errors are
resolved.
- Around line 54-56: Update the README requirement list to use Apple's official
casing by replacing "MacOS" with "macOS" in the bullet that currently reads
"Linux or MacOS (Intel or M-series)"; ensure the change appears exactly in the
requirements section so the line becomes "Linux or macOS (Intel or M-series)" to
prevent documentation lint errors.
- Around line 224-231: Replace the placeholder "#" links in the Cookbooks list
entries (e.g., the markdown list items "Unstract + PostgreSQL + DeepSeek",
"Unstract + n8n", "Unstract + Snowflake", "Unstract + BigQuery", "Unstract +
Crew.AI", "Unstract + PydanticAI", and "Unstract MCP Server") with either their
correct target URLs or convert those list items to plain text headings until the
real URLs are available; update the README.md entries so no anchor text uses a
bare "#" to avoid linting/UX issues.
- Around line 125-141: The fenced ASCII architecture block in README.md is
missing a language tag; update the triple-backtick fence that contains the
Unstract diagram to use a language (use "text") so the block becomes ```text and
keep the diagram contents unchanged; locate the fenced block by its distinctive
ASCII diagram header
"┌─────────────────────────────────────────────────────────────┐" / the title
"Unstract" to find the exact spot.
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Extracted from the Confluence spec page and added: - prompt_studio.gif: Prompt Studio demo animation - api_deployment.gif: API Deployment demo animation (compressed to <10MB) - github_star.gif: Star repo prompt animation Updated README to reference GIFs instead of static PNG. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
vishnuszipstack
requested review from
chandrasekharan-zipstack,
hari-kuriakose,
jaseemjaskp,
ritwik-g and
shuveb
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- Fix "MacOS" → "macOS" to match Apple's official styling - Add language identifier to architecture code fence for markdown lint 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
- Fix "MacOS" → "macOS" to match Apple's official styling - Add language identifier to architecture code fence - Convert header section to pure HTML for proper center alignment - Convert footer section to pure HTML for proper center alignment - Wrap star callout and gif in blockquote - Use GitHub alert syntax for backup encryption warning - Remove placeholder "#" links from Use Cases and Cookbooks - Add real URLs to Cookbooks section - Various text improvements and formatting fixes 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
Convert remaining markdown badge syntax to pure HTML within the center-aligned div for consistent rendering. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
Signed-off-by: Hari John Kuriakose <hari@zipstack.com>
Change badge style from flat-square to flat for slightly rounded corners. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
|
Contributor
Test ResultsSummary
Runner Tests - Full Report
SDK1 Tests - Full Report
|
hari-kuriakose
approved these changes
Feb 28, 2026
Contributor
hari-kuriakose
left a comment
hari-kuriakose
left a comment
There was a problem hiding this comment.
@vishnuszipstack LGTM overall
hari-kuriakose
approved these changes
Mar 1, 2026
Contributor
hari-kuriakose
left a comment
hari-kuriakose
left a comment
There was a problem hiding this comment.
@vishnuszipstack LGTM overall
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
2 participants
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.
What
Why
How
Cache (Redis)andMessage Queue (RabbitMQ)as separate rowsENCRYPTION_KEYbackup warning moved to its own "Backup Encryption Key" section under "Other Deployment Options" (not under Development)#links for Cookbooks and Use Cases sections pending final URLsCan this PR break any existing features. If yes, please list possible items. If no, please explain why. (PS: Admins do not merge the PR without this section filled)
Database Migrations
Env Config
Relevant Docs
Related Issues or PRs
Dependencies Versions
Notes on Testing
#links for Cookbooks and Use Cases once URLs are availableScreenshots
N/A — review the rendered README in the "Files changed" tab.
Checklist
I have read and understood the Contribution Guidelines.