[Portal] Nebula documentation update #6201
Merged
+320
−175
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 ↗︎
|
saminacodes
changed the title
github-actions
bot
added
the
Portal
Contributor
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. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #6201 +/- ##
=======================================
Coverage 56.72% 56.72%
=======================================
Files 1161 1161
Lines 64289 64289
Branches 5196 5196
=======================================
Hits 36468 36468
Misses 27095 27095
Partials 726 726
*This pull request uses carry forward flags. Click here to find out more. |
Contributor
size-limit report 📦
|
saminacodes
added
the
merge-queue
Member
Author
Merge activity
|
MananTank
reviewed
Feb 10, 2025
MananTank
approved these changes
Feb 10, 2025
graphite-app bot
pushed a commit
that referenced
this pull request
Feb 10, 2025
CORE-0000
<!-- start pr-codex -->
---
## PR-Codex overview
This PR enhances the documentation for `thirdweb Nebula`, adding metadata for various pages, improving FAQs, and introducing new sections on context filters, sessions, and response handling. It also updates the sidebar and integrates new features for better user guidance.
### Detailed summary
- Added `metadata` exports for multiple pages.
- Expanded FAQs with links for further information.
- Introduced sections on `Chat & Execute endpoints`, `Execute Configuration`, and `Sessions`.
- Updated sidebar to include new key concepts.
- Enhanced response handling documentation, including streaming and non-streaming responses.
> ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your question}`
<!-- end pr-codex -->
graphite-app
bot
force-pushed
the
neb-docs
branch
from
7cce978 to
d2c56ba
Compare
![graphite-app[bot]](https://avatars.githubusercontent.com/in/158384?s=60&v=4){kind=small}
Comment on lines
+8
to
+13
| - [Create Session](/api-reference/create-session) | ||
| - [Get Session](/api-reference/get-session) | ||
| - [Clear Session](/api-reference/clear-session) | ||
| - [Update Session](/api-reference/update-session) | ||
| - [Delete Session](/api-reference/delete-session) | ||
| - [List Sessions](/api-reference/list-sessions) |
Contributor
There was a problem hiding this comment.
The session endpoint links need to be updated to include the /nebula/api-reference/ prefix to match the documentation structure. For example:
- [Create Session](/api-reference/create-session)
+ [Create Session](/nebula/api-reference/create-session)This change should be applied to all session endpoint links in this section.
Spotted by Graphite Reviewer
Is this helpful? React 👍 or 👎 to let us know.
CORE-0000
<!-- start pr-codex -->
---
## PR-Codex overview
This PR enhances the documentation for `thirdweb Nebula`, adding detailed metadata, explanations of new features, and clarifying existing concepts. It includes updates to various pages, improving user understanding of plugins, sessions, context filters, and response handling.
### Detailed summary
- Added `metadata` exports to multiple `.mdx` files.
- Enhanced FAQ entries with links and additional context.
- Updated `sidebar` to include new key concepts.
- Added sections on `Chat & Execute endpoints`, `Execute Configuration`, and `Context Filters`.
- Introduced new content on `Response Handling` and streaming vs non-streaming responses.
- Clarified `Sessions` management and benefits.
- Replaced `Stack` with `Grid` in the `page.mdx` and updated links.
- Improved descriptions and examples for API usage and configurations.
> ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your question}`
<!-- end pr-codex -->
graphite-app
bot
force-pushed
the
neb-docs
branch
from
97000fd to
633f0ca
Compare
vercel
bot
temporarily deployed
to
Production – thirdweb_playground
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.
CORE-0000
PR-Codex overview
This PR enhances the documentation for
thirdweb Nebula, adding metadata, improving content clarity, and introducing new sections on key concepts, response handling, and session management. It also updates the sidebar for easier navigation.Detailed summary
metadataexports to multiple documentation files.Chat & Execute,Context Filters, andSessions.Response Handling, including streaming responses.API ReferenceandGet Startedsections for clarity.