Skip to content

Document draw usage in README and AGENTS guide - #30

Merged
kalashnikovisme merged 3 commits into
drawfrom
codex/add-draw-method-usage-to-readme-and-agents.md
Feb 18, 2026
Merged

Document draw usage in README and AGENTS guide#30
kalashnikovisme merged 3 commits into
drawfrom
codex/add-draw-method-usage-to-readme-and-agents.md

Conversation

@kalashnikovisme

Copy link
Copy Markdown
Member

Motivation

  • The draw helper in Purple::Client lets authors split large wrapper DSL definitions across multiple files, but the project lacked explicit guidance on how to use it.
  • Documentation and contributor guidance should show draw behavior so wrappers and automated agents authoring wrappers use it correctly.

Description

  • Added a README.md section titled "Splitting large wrappers with draw" that documents relative-path resolution, the optional .rb extension, and includes a concrete example showing both extensionless and explicit .rb draw calls.
  • Added a matching section to AGENTS.md titled "Organizing wrappers with draw" so contributors and LLM-guided agents receive the same guidance.
  • Included a clear rule to keep drawn files declarative (only path, params, response, body, root_method) and to avoid embedding business logic in drawn files.

Testing

  • Verified the documentation changes with git diff -- README.md AGENTS.md.
  • Confirmed repository state with git status --short and committed the updated files.
  • No runtime or unit tests were required because this change is documentation-only.

Codex Task

Clarify usage of `draw` paths and content rules for drawn files.
@kalashnikovisme
kalashnikovisme merged commit a1add99 into draw Feb 18, 2026
1 check passed
@kalashnikovisme
kalashnikovisme deleted the codex/add-draw-method-usage-to-readme-and-agents.md branch February 18, 2026 19:33
kalashnikovisme added a commit that referenced this pull request Feb 18, 2026
* Add draw using example

* Fix

* Add `draw` DSL loader to `Purple::Client` and spec for example usage (#29)

* Add draw DSL loader and specs for example usage

* Fix draw spec root path expectation type

* Fix draw spec to avoid executing leaf path request

* Document `draw` usage in README and AGENTS guide (#30)

* Document draw usage in README and AGENTS guide

* Update AGENTS.md

* Update AGENTS.md with `draw` paths clarification

Clarify usage of `draw` paths and content rules for drawn files.
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