Skip to content

docs: cancel ScientificWriterAgent (CAJAL) docs — feature reverted in PraisonAI#1641 #331

@MervinPraison

Description

@MervinPraison

Background

Upstream PR MervinPraison/PraisonAI#1641 (merged 2026-05-09 21:42:08Z) reverts PR MervinPraison/PraisonAI#1611 ("feat: Integrate CAJAL Scientific Writer Agent"). The revert removes the entire ScientificWriterAgent / PaperSection / ScientificPaper surface from the SDK.

A pre-existing docs issue — #327 ("docs(features): add ScientificWriterAgent (CAJAL) documentation page") — was filed minutes earlier (2026-05-09 21:42:42Z) from the original feature merge. That issue is now obsolete: it asks for documentation of a feature that no longer exists in the codebase.

This issue's purpose: tell the docs agent not to create the page, and to close #327.


Decision: No content update, no new content — close obsolete request

Check Result
ScientificWriterAgent exists in praisonaiagents/? ❌ Removed by #1641
praisonaiagents/agent/scientific_writer_agent.py exists? ❌ Deleted
examples/scientific_writing/cajal_integration_example.py exists? ❌ Deleted
Top-level export from praisonaiagents/__init__.py? ❌ Removed
Sub-package export from praisonaiagents/agent/__init__.py? ❌ Removed
docs/features/scientific-writer-agent.mdx already created? ❌ Not created
docs.json registers the page under Specialized Agents? ❌ Not registered (only codeagent, mathagent)
Any other docs reference CAJAL / ScientificWriter / P2PCLAW? ❌ No matches in docs/, examples/, or docs.json

Action: do not create docs/features/scientific-writer-agent.mdx. Close issue #327 as not_planned. No content needs to be added or removed in PraisonAIDocs.


Verification (against current main of MervinPraison/PraisonAI @ b636dd1)

The revert PR #1641 deleted/reverted these files (per AGENTS.md §1.4 source-of-truth check):

File Status after revert
src/praisonai-agents/praisonaiagents/agent/scientific_writer_agent.py removed (386 lines)
src/praisonai-agents/tests/unit/agent/test_scientific_writer_agent.py removed (323 lines)
examples/scientific_writing/cajal_integration_example.py removed (205 lines)
src/praisonai-agents/praisonaiagents/__init__.py ScientificWriterAgent, PaperSection, ScientificPaper entries removed from lazy export map
src/praisonai-agents/praisonaiagents/agent/__init__.py ScientificWriterAgent, PaperSection, ScientificPaper entries removed from __getattr__ and __all__

Per AGENTS.md §1.3 ("Documentation MUST reflect SDK ground truth … Never document features that don't exist in SDK"), no docs page may be created for this feature while it remains absent from the SDK.


Required actions for the docs agent

  1. Do NOT create docs/features/scientific-writer-agent.mdx.
  2. Do NOT modify docs.json — the "Specialized Agents" group should remain [codeagent, mathagent].
  3. Close issue docs(features): add ScientificWriterAgent (CAJAL) documentation page #327 as not_planned with a comment linking to this issue and to PraisonAI#1641, e.g.:

    Feature reverted upstream by Revert "feat: Integrate CAJAL Scientific Writer Agent" PraisonAI#1641 — closing per #(this-issue-number). Will reopen if the feature is reintroduced.

  4. Sanity-check (already verified, but re-run before closing):
    • grep -ril "cajal\|ScientificWriter\|P2PCLAW" docs/ docs.json → should return no results.
    • ls docs/features/ | grep -iE "scientific|cajal|paper-writer" → should return no results.
  5. If any stray reference is found in step 4, open a small cleanup PR removing it; otherwise no PR is needed.

Folder placement note (per AGENTS.md §1.8)

No file would have been written under docs/concepts/ anyway — but reaffirming: do not touch docs/concepts/, docs/js/, or docs/rust/. Even the cleanup search above is read-only against those folders.


What to do if the feature returns

If a future PR re-introduces ScientificWriterAgent (or a successor), a fresh docs issue should be filed at that point — do not revive #327 or this issue. The new issue should re-verify the SDK source per AGENTS.md §1.2 cycle (READ → UNDERSTAND → DOCUMENT) since the API may have changed on re-introduction.


References


This issue was generated automatically in response to the merge of MervinPraison/PraisonAI#1641 (pull_request.closed, merged=true).

Metadata

Metadata

Assignees

No one assigned

    Labels

    claudeTrigger Claude Code analysisdocumentationImprovements or additions to documentation

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions