Skip to content

Conversation

@mscolnick
Copy link
Contributor

@mscolnick mscolnick commented May 22, 2025

Fixes #4305

#### GitHub Copilot

You can use your GitHub Copilot for code refactoring or the chat panel. This requires a GitHub Copilot subscription.

1. Download the `gh` CLI from [here](https://cli.github.com/).
2. Create a token with `gh auth token` and copy the token.
3. Add the token to your `marimo.toml` (or configure in the UI settings in the editor).

```toml title="marimo.toml"
[ai.open_ai]
model = "gpt-4o"
api_key = "gho_..."
base_url = "https://api.githubcopilot.com/"
```

@vercel
Copy link

vercel bot commented May 22, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
marimo-docs ❌ Failed (Inspect) May 22, 2025 1:42am

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR updates the documentation for configuring and using AI completions with marimo by adding a GitHub Copilot section and standardizing the configuration file path references. Key changes include:

  • Introducing a dedicated GitHub Copilot section with setup instructions.
  • Updating configuration file paths to use $XDG_CONFIG_HOME/marimo/marimo.toml.
  • Standardizing UI configuration hints across various guides.

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

File Description
docs/guides/editor_features/ai_completion.md Added GitHub Copilot instructions and updated configuration hints.
docs/guides/configuration/index.md Updated configuration file path to $XDG_CONFIG_HOME/marimo/marimo.toml.
docs/getting_started/quickstart.md Updated configuration file path to $XDG_CONFIG_HOME/marimo/marimo.toml.
Comments suppressed due to low confidence (1)

docs/guides/configuration/index.md:26

  • Ensure that the change in the configuration file path is also documented in the release notes or migration guide to help users transition smoothly.
in a "$XDG_CONFIG_HOME/marimo/marimo.toml" file.

1. Install openai: `pip install openai`

2. Add the following to your `marimo.toml`:
2. Add the following to your `marimo.toml` (or configure in the UI settings in the editor):
Copy link

Copilot AI May 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For clarity and consistency, consider adding a brief note explaining why the alternative UI configuration exists and when it should be used.

Copilot uses AI. Check for mistakes.
Copy link
Contributor

@akshayka akshayka left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@mscolnick mscolnick merged commit 12333d2 into main May 22, 2025
33 of 37 checks passed
@mscolnick mscolnick deleted the ms/docs-gh-endpoint branch May 22, 2025 01:55
@github-actions
Copy link

🚀 Development release published. You may be able to view the changes at https://marimo.app?v=0.13.12-dev16

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Github Copilot LLM AI assistance

3 participants