Skip to content

feat(cli): Add documentation type discovery - #6

Merged
philprime merged 2 commits into
mainfrom
philprime/feat/add-type-discovery
Sep 9, 2026
Merged

feat(cli): Add documentation type discovery#6
philprime merged 2 commits into
mainfrom
philprime/feat/add-type-discovery

Conversation

@philprime

Copy link
Copy Markdown
Member

Add root DocC symbol discovery and make type lookup more resilient. Users can now inspect a technology’s direct symbols, follow nested documentation paths, and recover from missing or unsupported lookups with actionable links.

CLI Behavior

  • Add apple-docs types list --technology <technology> with table and JSON output.
  • Resolve nested symbols from dotted Swift names or slash-separated DocC paths.
  • Map missing symbols, unknown technologies, and external documentation to focused guidance.
  • Preserve raw DocC bytes without eager decoding and render inline codeVoice content plus follow-up URLs.

Verification

  • make test with 50 unit and behavior tests passing.
  • make analyze with no lint, format, or actionlint violations.
  • swift build -c release.
  • TELEMETRY_DISABLED=true make test-integration with 6 live integration tests passing.

Comment thread Sources/CLI/client/AppleDocumentationClient.swift Outdated
@philprime
philprime added this pull request to stack #8 September 9, 2026 14:40
@philprime
philprime disabled the stack merge September 9, 2026 14:41
List symbols from technology root DocC pages and expose stable table and JSON output. Resolve nested paths, map lookup failures to actionable links, and preserve raw responses without eager decoding.
Return actionable unsupported-technology guidance when a catalog-resolved DocC root also returns 404. Avoid repeating the same case-insensitive request when the original path already used the resolved slug.
@philprime
philprime force-pushed the philprime/feat/add-type-discovery branch from 9ff76b9 to 07747e8 Compare September 9, 2026 14:42
@philprime
philprime merged commit 07747e8 into main Sep 9, 2026
7 of 8 checks passed
@philprime
philprime deleted the philprime/feat/add-type-discovery branch September 9, 2026 14:43
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.

1 participant