docs: generate agent-readable Swift SDK documentation - #2
Open
bbbbzzzzcc-afk wants to merge 2 commits into
Open
Conversation
bbbbzzzzcc-afk
marked this pull request as ready for review
July 19, 2026 04:09
Author
|
Hi @piotrekno1 — this contribution is ready for review. The documentation build and validation pass, and the change is limited to the generated Swift API documentation and its publishing support. I am happy to adjust the scope or split the change if that would make review easier. |
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
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.
Closes wild-edge/wildedge-swift#6.
Summary
wild-edge/wildedge-swift, pinned to commitbf96ab894d83b72884dc8d44a065a36d1c5f0376llms.txtandllms-full.txtat the documentation root withabsolute links to setup, API reference, output metadata, queue behavior,
and examples
project-owned URLs, and pinned source links
Why
The issue asks for an agent-readable index that stays in sync with the SDK.
The build now extracts the SDK's public Swift declarations at a fixed commit,
turns them into source-mapped Markdown, and lets Sourcey publish the navigable
HTML and machine-readable indexes as part of the existing documentation build.
The output therefore changes only when the pinned SDK commit is deliberately
updated.
No WildEdge SDK runtime code is changed.
Verification
Local validation result:
HTTP smoke tests returned
200for/,/llms.txt,/swift-api/, the APIoverview, and the generated
CoreTypesreference page. The rootllms.txtwas served as
text/plain.