Add llms.txt file to insight docs #5887
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
the
Portal
Contributor
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. |
![graphite-app[bot]](https://avatars.githubusercontent.com/in/158384?s=60&v=4){kind=small}
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #5887 +/- ##
=======================================
Coverage 55.37% 55.37%
=======================================
Files 1123 1123
Lines 59642 59642
Branches 5056 5056
=======================================
Hits 33024 33024
Misses 25894 25894
Partials 724 724
*This pull request uses carry forward flags. Click here to find out more. |
Contributor
size-limit report 📦
|
AmineAfia
force-pushed
the
01-05-add_llms.txt_file_to_insight_docs
branch
from
774871f to
5c7f364
Compare
AmineAfia
force-pushed
the
01-05-add_llms.txt_file_to_insight_docs
branch
from
5c7f364 to
9de8eda
Compare
AmineAfia
force-pushed
the
01-05-add_llms.txt_file_to_insight_docs
branch
from
9de8eda to
024eb28
Compare
AmineAfia
pushed a commit
that referenced
this pull request
Jan 6, 2025
---
title: "[SDK/Dashboard/Portal] Feature/Fix: Concise title for the changes"
---
If you did not copy the branch name from Linear, paste the issue tag here (format is TEAM-0000):
## Notes for the reviewer
Anything important to call out? Be sure to also clarify these in your comments.
## How to test
Unit tests, playground, etc.
<!-- start pr-codex -->
---
## PR-Codex overview
This PR enhances the `insight` application by adding a new `llms.txt` file link in the sidebar and updating the content in the `agents-and-llms` documentation to provide clearer instructions for using the API with AI agents and LLMs.
### Detailed summary
- Added a new link for `llms.txt` in the sidebar of `sidebar.tsx`.
- Updated the introduction in `page.mdx` to clarify the use of the `llms.txt` file.
- Included a link to the `llms.txt` file in the documentation.
- Expanded API usage instructions and details in `llmstxt/page.mdx`.
- Added sections on rate limiting, pagination, error handling, and authentication methods.
- Provided code examples for API calls and error handling best practices.
> ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your question}`
<!-- end pr-codex -->
AmineAfia
force-pushed
the
01-05-add_llms.txt_file_to_insight_docs
branch
from
4f5eeb6 to
c07ff58
Compare
AmineAfia
commented
Jan 6, 2025
---
title: "[SDK/Dashboard/Portal] Feature/Fix: Concise title for the changes"
---
If you did not copy the branch name from Linear, paste the issue tag here (format is TEAM-0000):
## Notes for the reviewer
Anything important to call out? Be sure to also clarify these in your comments.
## How to test
Unit tests, playground, etc.
<!-- start pr-codex -->
---
## PR-Codex overview
This PR focuses on enhancing the documentation and functionality related to `Agents & LLMs` within the `thirdweb Insight` API, including new links, improved examples, and standardized usage instructions for better integration with AI tools.
### Detailed summary
- Added a new link for `llms.txt` in `sidebar.tsx`.
- Updated documentation in `page.mdx` to clarify API usage for `Agents & LLMs`.
- Revised code examples to use template literals for dynamic values.
- Simplified `ChainId` type to a number.
- Enhanced error handling and response structure in API examples.
- Included detailed instructions on authentication and API endpoints.
> ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your question}`
<!-- end pr-codex -->
AmineAfia
force-pushed
the
01-05-add_llms.txt_file_to_insight_docs
branch
from
5767934 to
66f1337
Compare
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.
title: "[SDK/Dashboard/Portal] Feature/Fix: Concise title for the changes"
If you did not copy the branch name from Linear, paste the issue tag here (format is TEAM-0000):
Notes for the reviewer
Anything important to call out? Be sure to also clarify these in your comments.
How to test
Unit tests, playground, etc.
PR-Codex overview
This PR enhances the documentation and functionality of the
InsightAPI, specifically for agents and LLMs, by adding new links, improving API usage instructions, and updating code examples for better clarity and usability.Detailed summary
llms.txtinsidebar.tsx.page.mdxfor clarity on usingInsightwith AI agents.ChainIdtype definition tonumber.