Skip to content

docs(readme): finish the repositioning — regulated teams and everyone, pip install praisonai, praison.ai/docs links - #6230

Merged
MervinPraison merged 4 commits into
mainfrom
docs/readme-pitch-followup
Nov 4, 2026
Merged

MervinPraison merged 4 commits into
mainfrom
docs/readme-pitch-followup

Conversation

@MervinPraison

@MervinPraison MervinPraison commented Nov 4, 2026 •

Copy link
Copy Markdown
Owner

Why this PR

#6226 was merged by the gate at 12:35. The last three commits on its branch landed about 10 minutes after that, so they never reached main. This PR carries those commits over unchanged, on top of the current main. Text only.

What changes

  • Top of the page:
    • Main line: PraisonAI runs AI agents on your own computers, even fully offline, so private data never has to leave the building.
    • Two short lines under it: For highly regulated teams (early access) for the handover, and For everyone else for the free, open-source framework, which needs no API key with a local model.
    • Each number at the top links to its public source.
  • Install: pip install praisonai is the main install line; praisonaiagents is described as the lightweight core. The offline section no longer needs the [llm] extra.
  • Handover section: adds why now, citing OpenAI's 6 Jan 2027 fine-tuning notice, and what the handover is built on today.
  • New "The company" section for investors and partners: co-founders, what we're building (early access, "taking on our first design partners"), why now, how the free framework and the licensed handover fit together, traction, and contact (enterprise@praison.ai).
  • Docs links: all docs.praison.ai links now point to praison.ai/docs. I checked each new URL returns 200 first, and checked the other 100 links on the page.
  • Wrapper README: src/praisonai/README.md is kept byte-identical.

Nothing is removed. After allowing for the domain move, every old link target is still present. No code, examples or imports change.

Verified

  • Offline run: with a clean pip install praisonai (4.7.23), the Python offline example answered with the internet blocked.
  • Honesty review: an investor and compliance read-through ran on this text. Its fixes are included:
    • the early-access label comes first;
    • "never has to leave", not "never leaves";
    • no claim that design partners already exist;
    • no unsupported release-pace claim;
    • no pricing or market-size claims.

Related: #6228. The CLI with --model ollama/... fails on the API-key check, so the README shows only the Python route for running offline.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Updated the README to describe PraisonAI’s offline capabilities and distinguish its framework offerings.
    • Revised installation guidance, including the default package and lightweight-core option.
    • Added information about task handover, quality checks, rollback, and transfer records.
    • Refreshed feature references and documentation links to use the current domain.

MervinPraison and others added 3 commits November 4, 2026 13:03
…sonai; praison.ai/docs links

- Top: one main line, then one line for highly regulated teams (the handover,
  early access) and one for everyone else (free, open source, no API key with
  a local model). Numbers now link to their public sources.
- Install line is pip install praisonai (praisonaiagents noted as the light core).
  The offline section no longer needs the [llm] extra: praisonai ships litellm.
- How the handover works: adds why now and what it is built on today.
- New 'The company' section for investors and partners: who, what, how the open
  framework and the licensed handover fit, traction, contact.
- All 128 docs.praison.ai links moved to praison.ai/docs after checking each
  new URL returns 200; every other link checked too.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
…nAI notice, add why now, co-founders and contact email; no unproven partner or release-pace claims

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Copilot AI balanced review requested due to automatic review settings November 4, 2026 13:03
@qodo-code-review

Copy link
Copy Markdown

ⓘ Qodo reviews are paused because the subscription is no longer active. Ask your workspace admin to reactivate the subscription to resume reviews. Manage billing

Copilot AI 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.

Copilot was unable to review this pull request because the user who requested the review has insufficient remaining quota. Try requesting a review at a lower effort level.

@coderabbitai

coderabbitai Bot commented Nov 4, 2026 •

Copy link
Copy Markdown
Contributor

Explain Change →

Caution

Review failed

The pull request is closed.

No actionable comments were generated in the recent review.

Walkthrough

Both README files update PraisonAI’s positioning and installation guidance, describe the regulated-team handover offering and company, and replace documentation links with praison.ai links.

Changes: README updates

Layer / File(s) Summary
Overview and installation guidance
README.md, src/praisonai/README.md
The introductions present PraisonAI as an offline-capable framework, distinguish the regulated-team offering, and update installation instructions.
Handover and company information
README.md, src/praisonai/README.md
The README content describes the early-access task handover, framework features, and company information.
Documentation link updates
README.md, src/praisonai/README.md
Documentation links across feature tables, guides, help sections, and footers now use the praison.ai domain.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Other

Possibly related PRs

Suggested reviewers: putramkti

Merge Risk: Minimal · previous review 48b73

The README updates present no established merge-blocking issue and are mergeable subject to normal checks.

Pre-merge checks: Passed 5
Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title is a Conventional Commits style docs(readme) title and matches the main change: README repositioning for regulated teams and general users, making pip install praisonai the primary install…
Docstring Coverage Passed No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentat…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Title check

Explanation

The title is a Conventional Commits style docs(readme) title and matches the main change: README repositioning for regulated teams and general users, making pip install praisonai the primary install, and switching documentation links to praison.ai/docs. It is specific and conveys the primary change. It does not cover the handover section detail or the wording revisions, which is acceptable.

Full details: Docstring Coverage

Explanation

No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 0 files. (2 skipped: 2 unsupported.)

  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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.

Share
Recent review info
Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: c570addc-dac4-4cb0-b29d-54a64f14dda8
Commits

Reviewing files that changed from the base of the PR and between 534b6e3 and 48b731b.

Files selected for processing: 2
  • README.md
  • src/praisonai/README.md

Included review availability: This review used your included allowance. Your plan provides up to 8 included reviews per hour; 7 remain after this review.

@greptile-apps

greptile-apps Bot commented Nov 4, 2026 •

Copy link
Copy Markdown
Contributor

RetriggerView in GreptileConfidence Score: 5/5

[Low impact] The PR appears safe to merge.

Summary

Updates both README copies to explain the free framework and early-access handover, make pip install praisonai the main install command, and move documentation links to praison.ai/docs.

  • The README explains who PraisonAI is for and which package to install.
  • The README explains why the handover matters and who is building it.
  • The README's documentation links use the current praison.ai/docs address.

Reviews (2) · Last reviewed commit: "fix: note praisonaiagents[llm] extra for..." · Reviewed by Greptile

Comment thread README.md Resolved
@MervinPraison

Copy link
Copy Markdown
Owner Author

@claude You are the FINAL architecture reviewer. If the branch is under MervinPraison/PraisonAI (not a fork), you are able to make modifications to this branch and push directly. SCOPE: Review changes in this PR. Python SDK: praisonaiagents, praisonai. TypeScript SDK: src/praisonai-ts/. Do NOT modify src/praisonai-rust. Read ALL comments above from Gemini, Qodo, CodeRabbit, and Copilot carefully before responding.

MANDATORY READ (before reviewing):

  • Always read src/praisonai-agents/AGENTS.md
  • If this PR touches src/praisonai-ts/, also read src/praisonai-ts/AGENTS.md §2.1.2 (TS triage + PR review checklist)

Phase 1: Review per AGENTS.md

  1. Protocol-driven: check heavy implementations vs core SDK
  2. Backward compatible: ensure zero feature regressions
  3. Performance: no hot-path regressions
  4. SDK value: review in depth whether the change genuinely adds value to the SDK — never add features for the sake of adding them. It must strengthen the SDK (simpler, more user-friendly, robust, world-class, secure). If it does not clearly add value, request changes or recommend rejecting/closing rather than merging scope creep
  5. Do not bloat the Agent class with additional params — only if absolutely required; we already support many params.
  6. Repo routing: agent-callable tools → PraisonAI-Tools; lifecycle plugins → PraisonAI-Plugins; optional sandbox backends → PraisonAI-Plugins (praisonai.sandbox entry point) — request changes if wrongly added to praisonaiagents/
    6b. External tool examples (examples/tools/external/**): If the diff is confined to that path, mark SDK value ❌ for monorepo merge — redirect the contributor to PraisonAI-Tools; do not Approve for merge unless the PR has the maintainer-accept-example label.
    6c. New vendor *_tools.py in core (src/praisonai-agents/praisonaiagents/tools/): If the PR adds a new *_tools.py for a third-party API/SaaS/dataset (e.g. FXMacroData), mark Repo routing ❌ and SDK value ❌ — redirect to MervinPraison/PraisonAI-Tools. Do not Approve because legacy bundled tools (Tavily/Exa/You.com/etc.) already in core are not precedent for new vendor modules. Request changes or recommend closing unless the PR has maintainer-accept-core-tools.

MANDATORY COMMENT FORMAT — include this Phase 1 table in your review comment:

Phase 1 — AGENTS.md review

Check Result
Protocol-driven / no heavy impl in core ✅ or ❌ + one-line rationale
Backward compatible ✅ or ❌ + one-line rationale
Performance (hot path) ✅ or ❌ + one-line rationale
SDK value ✅ or ❌ + one-line rationale (explicitly judge whether the change strengthens the SDK)
No Agent param bloat ✅ or ❌ + one-line rationale
Repo routing ✅ or ❌ + one-line rationale

For TypeScript PRs (src/praisonai-ts/), also add:
| TS types / parity / tests | ✅ or ❌ + one-line rationale (npm run build && npm test) |

Phase 2: FIX Valid Issues
7. For any VALID bugs or architectural flaws found by Gemini, CodeRabbit, Qodo, Copilot, or any other reviewer: implement the fix
8. Also independently identify and fix any gaps or issues you find in the changed code — do not rely only on prior reviewer feedback
9. Push all code fixes directly to THIS branch (do NOT create a new PR)
10. Comment a summary of exact files modified and what you skipped

Phase 3: Final Verdict
11. Never Approve or write “Approve for merge” if any Phase 1 row is ❌, if rule 6b/6c applies, or if the change belongs in PraisonAI-Tools/PraisonAI-Plugins. Use Request changes, redirect to the external repo, and recommend closing the monorepo PR when routing is wrong.
12. Approve only when every Phase 1 row is ✅ (including Repo routing and SDK value) and blocking issues are resolved; otherwise request changes with clear action items

@MervinPraison MervinPraison added pipeline/blocked:ci Blocked: CI not green on HEAD pipeline/blocked:cooldown Blocked: post-push or @claude cooldown pipeline/blocked:stale-final Blocked: FINAL stale after new commits pipeline/reviews-pending Waiting for CodeRabbit/Qodo/Copilot reviews labels Nov 4, 2026
…h READMEs

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@praisonai-triage-agent

praisonai-triage-agent Bot commented Nov 4, 2026 •

Copy link
Copy Markdown
Contributor

Phase 1 — AGENTS.md review

Check Result
Protocol-driven / no heavy impl in core ✅ Docs only (README.md, src/praisonai/README.md); no code touched
Backward compatible ✅ No API, import or CLI changes; text says existing packages and commands work as before
Performance (hot path) ✅ No runtime code
SDK value ✅ Clearer positioning, a working offline quick start, and doc links moved to praison.ai/docs
No Agent param bloat ✅ No params added. The examples use the existing model= and base_url=
Repo routing ✅ The READMEs belong in this repo. No tools or plugins added

Phase 2 — Fixes

  • Greptile P2 (valid): the PR dropped the old pip install "praisonaiagents[llm]" note. Core praisonaiagents doesn't depend on litellm (only the [llm] extra pulls it in), so if you install only the core library, the ollama/llama3.2 offline example raises ImportError. I added one sentence under "Run fully offline" in both copies that tells core-only users to install praisonaiagents[llm]. praisonai already depends on litellm, so the main pip install praisonai path was already fine.
  • Independent check: the in-page anchors (#how-the-handover-works-early-access, #full-feature-reference, #desktop-app, #-using-yaml-no-code, #-using-javascript-code) all point to headings that exist. The top section of the two README copies is still identical.

Files modified: README.md, src/praisonai/README.md (1 line each).
Skipped: nothing else needed fixing. Copilot and Qodo didn't review (quota/billing), and CodeRabbit had no actionable comments. I didn't run the Python or TS test suites because this PR changes docs only.

Phase 3 — Verdict

✅ Approve. Every Phase 1 check passes and the one valid reviewer issue is fixed. Merge note: all checks are passing apart from the skipped Mintlify deployment, so there is nothing in CI blocking the merge.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

pipeline/blocked:ci Blocked: CI not green on HEAD pipeline/blocked:cooldown Blocked: post-push or @claude cooldown pipeline/blocked:stale-final Blocked: FINAL stale after new commits pipeline/reviews-pending Waiting for CodeRabbit/Qodo/Copilot reviews

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants