Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
autopilot-project-manager
Bot
added
documentation
There was a problem hiding this comment.
Pull request overview
This PR adds “docs search” support to RxCode by introducing a CI-friendly docs uploader script and extending the macOS app UI to surface docs setup/management entry points and to include docs results in global (⌘K) search.
Changes:
- Add
scripts/upload_docs.pyto collect markdown docs withslugfrontmatter and upload them to the docs service in batches. - Add a “Set Up Docs Search” action in the project sidebar menu and a “Manage Docs” entry in Autopilot settings.
- Extend the global search overlay to search both threads (on-device) and docs (network) with filter tabs and a docs detail sheet.
Reviewed changes
Copilot reviewed 33 out of 33 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
scripts/upload_docs.py |
New stdlib-only uploader to batch POST docs content to the docs indexing service. |
RxCode/Views/Sidebar/ProjectTreeView.swift |
Adds a sidebar menu item to kick off docs-search setup via deep link. |
RxCode/Views/Settings/AutopilotSettingsTab.swift |
Adds a Documentation section and “Manage Docs” sheet entry point. |
RxCode/Views/Search/GlobalSearchOverlay.swift |
Integrates docs results into ⌘K global search with tabs, selection, and detail presentation. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+268
to
+272
| onSetupDocsSearch: { | ||
| guard let repo = project.gitHubRepo, | ||
| let url = DocsDeepLink.setupURL(repo: repo) else { return } | ||
| openURL(url) | ||
| }, |
| req = urllib.request.Request(url, data=data, method="POST") | ||
| req.add_header("Content-Type", "application/json") | ||
| req.add_header("Authorization", "Bearer " + token) | ||
| with urllib.request.urlopen(req) as resp: |
Comment on lines
+42
to
+45
| /// Docs results live alongside threads in a single, unified result list — | ||
| /// one query searches on-device threads and github-pm's docs index at once, | ||
| /// with no scope to pick. | ||
| @State private var docsHits: [DocsSearchHit] = [] |
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.
This pull request adds native support for documentation indexing, search, and setup in the app, integrating with the external docs service (github-pm's docs API). It introduces new models, workflow automation, and user interface hooks to streamline documentation publishing and discovery. The changes also add deep link handling and new backend capabilities to expose these features to agents and the UI.
Documentation Integration and Models:
DocsModels.swiftto represent repositories, documents, search results, upload tokens, and related API contracts for the docs service.Backend and Tooling Enhancements:
.docsSearchinBackendCapability.swift, allowing backends to declare support for native documentation search and suppress the polyfill.IDEToolRegistry.swift:ide__search_docsfor semantic search over published docs, andide__setup_docs_secretfor automating setup of the docs upload token as a GitHub Actions secret.App State and UI Integration:
AppStateto track per-repo docs status, manage docs setup requests, and provide high-level intents for refreshing and querying docs status. [1] [2] [3] [4]RxCodeApp.swiftto support docs setup links, triggering the appropriate UI flow when a docs setup deep link is opened. [1] [2] [3]Workflow Automation:
.github/workflows/upload-docs.yamlto automate uploading documentation to the docs service whenever relevant files change on the main branch.Hook and Service Integration:
DocsHookin the app's hook manager for macOS, and extended theHookControllerprotocol to support checking docs indexing status and handling pending docs setup skill injection. [1] [2]