docs: make README-read mandatory in Actor description - #4
Open
MQ37 wants to merge 2 commits into
Open
Conversation
Prior wording ("Read the README first.") sat at the end and was easy
to skip — a model reading only the truncated tools-get schema blurb
missed it and guessed the apify.* call signature wrong twice before
checking the README. Front-load it as MANDATORY so it survives
truncation and skimming.
Keep the original description text; only strengthen the trailing README instruction to MANDATORY instead of front-loading it.
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: Front-load
.actor/actor.json's description withMANDATORY: read README before calling, replacing the trailing "Read the README first."Why: Observed a model reading only the truncated
tools-getschema blurb, missing the trailing README instruction, and guessing theapify.*call signature (positional vs. options-object) wrong twice before finally reading the README. Putting the instruction first survives truncation/skimming.Testing:
python3 -c "import json; print(len(json.load(open('.actor/actor.json'))['description']))"→ 272 chars, under the 300-char Store description cap. No behavior change, description text only.