[TOOL-2896] Portal: Add Nebula API docs #5916
Merged
Conversation
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
|
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
github-actions
bot
added
Dashboard
Member
Author
How to use the Graphite Merge QueueAdd either label to this PR to merge it via the merge queue:
You must have a Graphite account in order to use the merge queue. Sign up using this link. An organization admin has enabled the Graphite Merge Queue in this repository. Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue. This stack of pull requests is managed by Graphite. Learn more about stacking. |
Contributor
size-limit report 📦
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #5916 +/- ##
==========================================
- Coverage 54.83% 54.82% -0.01%
==========================================
Files 1141 1141
Lines 60894 60894
Branches 5126 5126
==========================================
- Hits 33390 33386 -4
- Misses 26779 26782 +3
- Partials 725 726 +1
*This pull request uses carry forward flags. Click here to find out more. |
MananTank
changed the title
joaquim-verges
approved these changes
Jan 9, 2025
Contributor
Merge activity
|
## PR-Codex overview
This PR introduces several enhancements and new features to the `nebula` API, particularly focusing on the addition of wallet addresses in the chat API and the implementation of metadata components for API endpoints.
### Detailed summary
- Added `wallet_addresses` support in `chat.ts`.
- Updated `Layout` component to include `showTableOfContents`.
- Enhanced styling in `List.module.css`.
- Introduced `EndpointMetadata` component for API documentation.
- Refactored `InlineCode` component for better usage.
- Updated sidebar links to reflect new API endpoints.
- Added new API endpoints for `create`, `delete`, `clear`, `get`, `list`, and `update` session functionalities.
- Implemented response handling and request examples for new endpoints.
> The following files were skipped due to too many changes: `pnpm-lock.yaml`
> ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your question}`
<!-- end pr-codex -->
<!-- start pr-codex -->
---
## PR-Codex overview
This PR introduces various enhancements and new features to the `nebula` application, including improved UI components, new API endpoint metadata, and updates to documentation. It also integrates a new `Select` component and refines existing layout and styling.
### Detailed summary
- Added `What Can Nebula Do?` section in `page.mdx`.
- Introduced `wallet_addresses` in `chat.ts` API parameters.
- Included `@radix-ui/react-select` dependency in `package.json`.
- Updated `Layout` component to include a `showTableOfContents` prop.
- Enhanced CSS styles for lists in `List.module.css`.
- Modified `DocLayout` to conditionally render columns based on `showTableOfContents`.
- Replaced raw endpoint documentation with `<EndpointMetadata />` in several `page.mdx` files.
- Added `InlineCode` component for inline code rendering.
- Integrated `Callout` component in `plugins` documentation.
- Refactored `Function.tsx` to use `InlineCode`.
- Established API endpoint metadata for various actions (`clear-session`, `get-session`, `list-session`, etc.).
- Improved sidebar structure to categorize API actions by HTTP methods.
- Updated `tailwind.config.ts` for enhanced theming and layout.
- Introduced a new `Select` component with improved UI in `select.tsx`.
- Refined `ApiEndpoint` component for better request/response handling.
> The following files were skipped due to too many changes: `pnpm-lock.yaml`
> ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your question}`
<!-- end pr-codex -->
<!-- start pr-codex -->
---
## PR-Codex overview
This PR focuses on enhancing the `Nebula` API documentation and related components. It introduces new features, updates existing ones, and refines the user interface for better clarity and usability.
### Detailed summary
- Added `wallet_addresses` to `chat.ts`.
- Updated `Layout` component to include `showTableOfContents`.
- Enhanced styles in `List.module.css`.
- Introduced `InlineCode` component.
- Replaced example code with `<EndpointMetadata />` in several API reference pages.
- Added `Select` component for UI.
- Updated sidebar structure for clearer API organization.
- Improved `ApiEndpoint` component to handle request/response examples better.
- Enhanced `tailwind.config.ts` for improved styling.
> The following files were skipped due to too many changes: `pnpm-lock.yaml`
> ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your question}`
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.
PR-Codex overview
This PR introduces several enhancements and new features to the
nebulaAPI, particularly focusing on the addition of wallet addresses in the chat API and the implementation of metadata components for API endpoints.Detailed summary
wallet_addressessupport inchat.ts.Layoutcomponent to includeshowTableOfContents.List.module.css.EndpointMetadatacomponent for API documentation.InlineCodecomponent for better usage.create,delete,clear,get,list, andupdatesession functionalities.PR-Codex overview
This PR introduces enhancements to the
Nebulaapplication, including new API endpoints, improved layout components, and updated styling. It also adds a newSelectcomponent and integrates metadata for API endpoints, enhancing documentation and usability.Detailed summary
wallet_addressestochat.tsDocLayoutwith ashowTableOfContentspropInlineCodeandCodeBlockcomponentsSelectcomponent from@radix-ui/react-selectEndpointMetadatacomponents for various API referencesPR-Codex overview
This PR focuses on enhancing the
NebulaAPI documentation by adding new features, improving existing components, and refining styles in various areas. It introduces new API endpoints and updates the UI components for better usability.Detailed summary
showTableOfContentsprop toDocLayout.Selectcomponent from@radix-ui/react-select.InlineCodecomponent to improve styling.EndpointMetadatacomponent for API documentation.