docs: Focus README on local-only use cases, move developer docs to CONTRIBUTING.md - #73
Merged
Merged
Conversation
…NTRIBUTING.md Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01HKbUGBmHeGLhF9B245gJ8n
Pijukatel
marked this pull request as ready for review
September 23, 2026 15:43
Pijukatel
pushed a commit
that referenced
this pull request
Sep 23, 2026
Conflict in README.md: master (#73) rewrote it around what the runtime lets you do locally and moved the developer material into CONTRIBUTING.md. Took master's README wholesale and re-added this branch's specification note in the new shape - four lines under "What you can do only locally", where the endpoints those features use are introduced, instead of the 18-line section this branch had put between the Podman notes and the dev loop, both of which have since moved or gone. CONTRIBUTING.md's new "Specification" section says the behavioural spec lives in requirements/*.md, which stopped being the whole truth on this branch: it now names the OpenAPI document as the contract for the /actor-runtime/* namespace, with api.md pointing at it. No change to the document itself - #73 is documentation only and alters no behaviour it is normative for. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_016VvUV6661cyYbxoHZv2Pby
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
3 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.
README now covers only what users need: the quick start, and what the runtime can do that the Apify platform can't (dev folder, IDE debugging, browser view, on-demand migration, free pay-per-event testing, API fallback), plus Proxy and Podman setup.
Descriptions of standard platform features, such as input schema validation, are removed.
Building from source, development commands, the spec, the Crawlee bump and the image release workflows moved to the new CONTRIBUTING.md.
Generated by Claude Code