-
Notifications
You must be signed in to change notification settings - Fork 24
add llms.txt file #182
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
cindyytong
wants to merge
1
commit into
main
Choose a base branch
from
feat/add-llms-txt
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
add llms.txt file #182
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -3,6 +3,8 @@ project: | |
| type: posit-docs | ||
| render: | ||
| - "*.qmd" | ||
| resources: | ||
| - "llms.txt" | ||
|
|
||
| execute: | ||
| freeze: auto | ||
|
|
||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,56 @@ | ||
| # Positron | ||
|
|
||
| Positron is developed by Posit PBC, the creators of RStudio. It provides a modern, extensible IDE built on Code OSS with features specifically designed for data science workflows, including notebooks, scripts, consoles, plotting, and data exploration tools. | ||
|
|
||
| ## Key Features | ||
|
|
||
| - [Data Explorer](https://positron.posit.co/data-explorer): Interactive data exploration and visualization | ||
| - [Variables Pane](https://positron.posit.co/variables-pane): Inspect and debug variables in your session | ||
| - [Quarto Support](https://positron.posit.co/quarto): Easily create and publish Quarto documents from Positron | ||
| - [Jupyter Notebooks](https://positron.posit.co/jupyter-notebooks): Native notebook support | ||
| - [AI Assistant](https://positron.posit.co/assistant): Built-in AI Assistant for inline and chat assistance to streamline your data science workflows | ||
| - [Databot](https://positron.posit.co/databot): Databot is an experimental AI assistant designed to accelerate exploratory data analysis | ||
| - [Database Connections](https://positron.posit.co/connections-pane): Connect and explore databases | ||
| - [Remote Development](https://positron.posit.co/remote-ssh): Work on remote machines via SSH | ||
|
|
||
| ## Getting Started | ||
|
|
||
| - [Download Positron](https://positron.posit.co/download): Get the latest version for macOS, Windows, or Linux | ||
| - [Installation Guide](https://positron.posit.co/install): Step-by-step installation instructions | ||
| - [Welcome Guide](https://positron.posit.co/welcome): First steps with Positron | ||
| - [Managing Interpreters](https://positron.posit.co/managing-interpreters): Set up Python and R interpreters | ||
| - [Python Setup](https://positron.posit.co/python-installations): Configure Python environments | ||
| - [R Setup](https://positron.posit.co/r-installations): Configure R installations | ||
|
|
||
| ## Documentation | ||
|
|
||
| - [Features Overview](https://positron.posit.co/features): Complete feature list | ||
| - [Keyboard Shortcuts](https://positron.posit.co/keyboard-shortcuts): Essential keyboard commands | ||
| - [Extensions](https://positron.posit.co/extensions): Extend functionality with VSIX extensions | ||
| - [Extension Development](https://positron.posit.co/extension-development): Build custom extensions | ||
| - [Layout](https://positron.posit.co/layout): Customize the user interface | ||
| - [Command Palette](https://positron.posit.co/command-palette): Quick access to commands | ||
| - [Git Integration](https://positron.posit.co/git): Version control workflows | ||
|
|
||
| ## Migration Guides | ||
|
|
||
| - [Migrate from VS Code](https://positron.posit.co/migrate-vscode): Transitioning from Visual Studio Code | ||
| - [Migrate from RStudio](https://positron.posit.co/migrate-rstudio): Comprehensive RStudio migration guide | ||
| - [RStudio Keybindings](https://positron.posit.co/migrate-rstudio-keybindings): Match your RStudio shortcuts | ||
| - [RStudio Settings & Extensions](https://positron.posit.co/migrate-rstudio-settings-and-extensions): Configure Positron like RStudio | ||
| - [R Projects](https://positron.posit.co/migrate-rstudio-rproj): Working with .Rproj files | ||
|
|
||
| ## Support | ||
|
|
||
| - [Troubleshooting](https://positron.posit.co/troubleshooting): Common issues and solutions | ||
| - [FAQs](https://positron.posit.co/faqs): Frequently asked questions | ||
| - [Feedback](https://positron.posit.co/feedback): Report issues and request features | ||
| - [Privacy Policy](https://positron.posit.co/privacy): Data collection and privacy information | ||
| - [GitHub Repository](https://github.com/posit-dev/positron): View source code and contribute | ||
| - [Issue Tracker](https://github.com/posit-dev/positron/issues): Report bugs and request features | ||
|
|
||
| ## About | ||
|
|
||
| - [About Positron](https://positron.posit.co/about): Project goals and philosophy | ||
| - [Licensing](https://positron.posit.co/licensing): Elastic License 2.0 information | ||
| - [Release Notes](https://positron.posit.co/release-notes): Latest updates and changes | ||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@AshleyHenry15 do you have any suggestions on best practices for this?
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We have one on the docs site that we are using already, and I was running it through evaluations to see if it was actually helping/successful or if it was actually making things worse.
This is something that I spoke with Joe C about a while back and since this type of thing is so new, it is hard to gauge the "right way" to write the txt file and measure its success. For example, I read that you actually have to tell the LLMs to look for the file for it it utilize the file. IDK if that is still the case but if it is, it is basically "useless" unless a user knows that it exists on the site.
I would recommend pausing this PR and look into running it through evals first.
Here is a link to our file: https://docs.posit.co/llms.txt
Do you want to have a quick meeting to chat about the evals?
(I actually have it on my backlog to test out what Stripe is doing with the button for "llm" and the markdown link to add on the docs site to see if it is beneficial enough to explore for product docs)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
TY for the reply I'll add this as the agenda for our next sync! Will put this back into draft for now