Skip to content

docs: generate agent-readable Swift SDK documentation - #2

Open
bbbbzzzzcc-afk wants to merge 2 commits into
wild-edge:mainfrom
bbbbzzzzcc-afk:sourcey-swift-api-docs
Open

docs: generate agent-readable Swift SDK documentation#2
bbbbzzzzcc-afk wants to merge 2 commits into
wild-edge:mainfrom
bbbbzzzzcc-afk:sourcey-swift-api-docs

Conversation

@bbbbzzzzcc-afk

Copy link
Copy Markdown

Closes wild-edge/wildedge-swift#6.

Summary

  • generate a Sourcey API site from the public declarations in
    wild-edge/wildedge-swift, pinned to commit
    bf96ab894d83b72884dc8d44a065a36d1c5f0376
  • publish llms.txt and llms-full.txt at the documentation root with
    absolute links to setup, API reference, output metadata, queue behavior,
    and examples
  • add a Swift SDK navigation entry to the existing VitePress site
  • validate that the generated site contains at least 15 public declarations,
    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

npm ci
npm run build
npm run validate:swift-api

Local validation result:

Validated 204 declarations, 11 pages, 215 pinned source links, and
project-root llms.txt outputs.

HTTP smoke tests returned 200 for /, /llms.txt, /swift-api/, the API
overview, and the generated CoreTypes reference page. The root llms.txt
was served as text/plain.

@bbbbzzzzcc-afk
bbbbzzzzcc-afk marked this pull request as ready for review July 19, 2026 04:09
@bbbbzzzzcc-afk

Copy link
Copy Markdown
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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add llms.txt for the SDK documentation

1 participant