Skip to content

docs(crews): document missing/undocumented parameters in crew.py (OSS-32)#5409

Open
lorenzejay wants to merge 1 commit intomainfrom
docs/oss-32-crew-missing-params
Open

docs(crews): document missing/undocumented parameters in crew.py (OSS-32)#5409
lorenzejay wants to merge 1 commit intomainfrom
docs/oss-32-crew-missing-params

Conversation

@lorenzejay
Copy link
Copy Markdown
Collaborator

@lorenzejay lorenzejay commented Apr 10, 2026

Summary

Fixes OSS-32concepts/crews.mdx was 113 days behind crew.py, missing 8 public-facing parameters and the entire Checkpointing system.


Changes

1. 8 New Rows in the Crew Attributes Table

Parameter Description
chat_llm LLM used by crewai chat CLI to interact with the crew
before_kickoff_callbacks Programmatic list of callbacks run before kickoff (distinct from @before_kickoff decorator)
after_kickoff_callbacks Programmatic list of callbacks run after kickoff (distinct from @after_kickoff decorator)
tracing OTel tracing: True=always on, False=always off, None=inherit
skills Path directories or Skill objects applied to all agents in the crew
security_config SecurityConfig for crew fingerprinting/identity
checkpoint `CheckpointConfig

2. New ## Checkpointing Section (inserted before ## Memory Utilization)

  • Quick-startcheckpoint=True one-liner
  • Full controlCheckpointConfig with location, on_events, max_checkpoints
  • Resume patternCrew.from_checkpoint("path").kickoff()
  • CheckpointConfig attributes table — all 4 fields with types, defaults, and descriptions
  • Note explaining that checkpoint_inputs, checkpoint_train, and checkpoint_kickoff_event_id are auto-restored and don't need to be set manually

Acceptance Criteria (from OSS-32)

  • All 6 high-priority public API params in attribute table (chat_llm, before_kickoff_callbacks, after_kickoff_callbacks, tracing, skills, security_config)
  • checkpoint param documented and linked to new section
  • Checkpointing section with checkpoint=True quick-start code example
  • Crew.from_checkpoint() resume pattern documented
  • CheckpointConfig attributes table
  • Note on auto-restored checkpoint fields

Note

Low Risk
Docs-only change that adds missing public Crew parameters and usage guidance; low risk aside from potential for minor inaccuracies in examples/option descriptions.

Overview
Updates docs/en/concepts/crews.mdx to document previously missing Crew constructor options, adding rows for chat_llm, kickoff callback lists, tracing, skills, security_config, and checkpoint.

Adds a new Checkpointing section with quick-start and advanced CheckpointConfig examples, resume flow via Crew.from_checkpoint(), and a small attribute table describing checkpoint configuration fields.

Reviewed by Cursor Bugbot for commit 2b46d01. Bugbot is set up for automated code reviews on this repo. Configure here.

…SS-32)

- Add 8 missing parameters to the Crew Attributes table:
  chat_llm, before_kickoff_callbacks, after_kickoff_callbacks,
  tracing, skills, security_config, checkpoint
- Add new "## Checkpointing" section before "## Memory Utilization" with:
  - Quick-start checkpoint=True example
  - Full CheckpointConfig usage example
  - Crew.from_checkpoint() resume pattern
  - CheckpointConfig attributes table (location, on_events, provider, max_checkpoints)
  - Note on auto-restored checkpoint fields

Closes OSS-32
@linear
Copy link
Copy Markdown

linear bot commented Apr 10, 2026

@mintlify
Copy link
Copy Markdown

mintlify bot commented Apr 10, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
crewai 🟢 Ready View Preview Apr 10, 2026, 8:32 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

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

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant