docs: add DOCS.md as the public API reference - #4
Merged
Conversation
Scaffolds a root-level DOCS.md documenting the current public API (createFetchify, defineOptions, types, VERSION) so future changes have a fixed place to update instead of deciding ad hoc where docs live. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
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
1 participant
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.
Summary
DOCS.mddocumenting fetchify's current public API (createFetchify,defineOptions,FetchifyOptions,FetchifyMethod,VERSION, entry points)DOCS.mdfromREADME.mdDOCS.mdas the living reference to be kept in sync as the public API changes (tracked via newproject-documentationOpenSpec capability)No user-facing runtime/behavior change, so no changeset was added.
Test plan
DOCS.mdcontent matches the current exports insrc/index.ts/src/native.ts🤖 Generated with Claude Code