docs: update keplergl-jupyter docs for v0.4.0 by Copilot · Pull Request #3431 · keplergl/kepler.gl

Copilot · 2026-05-09T21:15:12Z

Confirm target file is /home/runner/work/kepler.gl/kepler.gl/bindings/python/README.md
Run existing validation commands for the bindings/python area to capture baseline status
Add a concise README section showing both Claude Code and Codex skill setup
Refine wording to keep Codex support while avoiding product-name ambiguity
Extend Codex setup guidance with skill folder structure and optional assets/icons using existing kepler.gl icon paths
Fix icon path examples to use repository-relative paths
Re-run relevant validation for the touched area
Summarize the README update and validation results

- Document theme and app_name parameters in KeplerGl() constructor - Document json_encoder, app_name, theme parameters in save_to_html() - Add new Section 8: Customize Theme and App Name - Add GeoDataFrame datetime and empty geometry handling docs - Update prerequisites to Python >= 3.9, modern Jupyter - Remove obsolete nbextension/labextension install steps - Update demo notebook links to bindings/python/notebooks/ - Add new notebook links (Theme, Empty GeoDataFrame, Datetime) - Modernize FAQ section - Update bindings/python/README.md with features overview Agent-Logs-Url: https://github.com/keplergl/kepler.gl/sessions/6329811c-d920-4f01-85f4-2def1e980723 Co-authored-by: lixun910 <2423887+lixun910@users.noreply.github.com>

Split the monolithic README.md into focused doc pages: - install.md: Installation instructions - widget-api.md: KeplerGl(), .add_data(), .data - data-formats.md: CSV, GeoJSON, DataFrame, GeoDataFrame, WKT - map-customization.md: Theme, app name, interactive customization - config.md: Save/load config, match config with data - save-and-export.md: save_to_html(), _repr_html_() - faq.md: FAQ, troubleshooting, demo notebooks Update table-of-contents.json and SUMMARY.md with new entries. Agent-Logs-Url: https://github.com/keplergl/kepler.gl/sessions/69e0abb3-2c7a-4b1b-886f-fe3d4485b925 Co-authored-by: lixun910 <2423887+lixun910@users.noreply.github.com>

Agent-Logs-Url: https://github.com/keplergl/kepler.gl/sessions/9f887b15-c6cb-4fa0-8d08-e0ac6dfc5756 Co-authored-by: lixun910 <2423887+lixun910@users.noreply.github.com>

Copilot

Pull request overview

This PR restructures the kepler.gl Jupyter documentation by splitting the previous monolithic docs/keplergl-jupyter/README.md into multiple focused sub-pages and wiring them into the docs navigation (GitBook SUMMARY.md and the Gatsby docs TOC).

Changes:

Split kepler.gl-jupyter user guide content into dedicated pages (install, widget API, data formats, customization, config, export, FAQ).
Update docs navigation to link to the new sub-pages.
Refresh Python bindings README with a clearer feature list.

Reviewed changes

Copilot reviewed 11 out of 11 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
SUMMARY.md	Adds keplergl-jupyter sub-page links to the GitBook-style sidebar.
docs/table-of-contents.json	Updates Gatsby docs navigation to include the new keplergl-jupyter pages.
docs/keplergl-jupyter/README.md	Converts the previous long-form guide into an index/landing page with links + quick start.
docs/keplergl-jupyter/install.md	New install/prerequisites page reflecting anywidget-based setup.
docs/keplergl-jupyter/widget-api.md	New API reference page for `KeplerGl()`, `.add_data()`, and `.data`.
docs/keplergl-jupyter/data-formats.md	New dedicated page describing supported input formats and examples.
docs/keplergl-jupyter/map-customization.md	New page describing interactive customization, theme, and app name.
docs/keplergl-jupyter/config.md	New page describing `.config` usage and matching config with data.
docs/keplergl-jupyter/save-and-export.md	New page describing widget state persistence, HTML export, and embedding.
docs/keplergl-jupyter/faq.md	New FAQ page with renumbered sections and updated troubleshooting guidance.
bindings/python/README.md	Adds a “Features” section summarizing key capabilities.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Agent-Logs-Url: https://github.com/keplergl/kepler.gl/sessions/515f8388-a304-4295-b4e4-cb3eab823ae9 Co-authored-by: lixun910 <2423887+lixun910@users.noreply.github.com>

lixun910 · 2026-05-09T21:57:04Z

@copilot apply changes based on the comments in this thread

- Fix broken TOC entry: point to docs/keplergl-jupyter (README) instead of non-existent user-guide page - Fix invalid Python syntax in config.md code example - Fix duplicate dict key data_3 → data_2 in widget-api.md - Normalize menu label to "Widgets" in save-and-export.md Agent-Logs-Url: https://github.com/keplergl/kepler.gl/sessions/139036cf-67ae-4adc-b8ea-3bd8e62c6490 Co-authored-by: lixun910 <2423887+lixun910@users.noreply.github.com>

Copilot · 2026-05-09T21:58:26Z

@copilot apply changes based on the comments in this thread

Applied all four review fixes in commit 0342241:

TOC broken link – Changed docs/keplergl-jupyter/user-guide → docs/keplergl-jupyter (resolves to the folder README).
Invalid Python in config.md – Replaced ... with a # ...other config options comment and fixed the trailing comma/brace mismatch.
Duplicate dict key in widget-api.md – Renamed the second data_3 to data_2 so all keys are unique.
Inconsistent menu label – Changed Widget > to Widgets > in save-and-export.md to match map-customization.md.

Copilot

Pull request overview

Copilot reviewed 11 out of 11 changed files in this pull request and generated 10 comments.

lixun910 · 2026-05-09T22:07:38Z

@copilot apply changes based on the comments in this thread

- data-formats.md: update GeoDataFrame to describe GeoArrow serialization (not legacy WKT), clarify datetime handling per widget vs HTML export - data-formats.md: add missing imports (json, pandas, geopandas) - README.md: add self-contained Quick Start with defined DataFrame - README.md: remove _repr_html_() reference (method doesn't exist) - widget-api.md: fix .add_data() params (name is optional, GeoDataFrame supported) - save-and-export.md: remove _repr_html_() section (not implemented) - config.md: fix Python syntax (add comma), remove Python 2 u'...' keys Agent-Logs-Url: https://github.com/keplergl/kepler.gl/sessions/64b64399-59a2-44a3-b12d-e75806ff424c Co-authored-by: lixun910 <2423887+lixun910@users.noreply.github.com>

Copilot · 2026-05-09T22:10:15Z

@copilot apply changes based on the comments in this thread

All 10 review comments addressed in commit ca71a02:

GeoDataFrame description – Updated to describe GeoArrow serialization (not legacy WKT/reprojection).
Datetime handling – Clarified: GeoArrow preserves Arrow timestamps in widget; HTML export uses json_encoder=str.
Missing imports – Added import json, import pandas as pd, and import geopandas as gpd to code snippets.
Quick Start df – Replaced undefined df with a self-contained DataFrame example.
README _repr_html_() – Removed reference (method not implemented).
.add_data() params – Updated: name is optional (default "data"), GeoDataFrame listed as accepted type.
_repr_html_() section – Removed entire section from save-and-export.md.
Config syntax – Added missing comma after mapState dict.
Python 2 u'...' keys – Replaced with Python 3 string literals.
GeoDataFrame import – Switched geopandas.read_file to gpd.read_file with proper import.

Copilot AI and others added 2 commits May 9, 2026 17:54

Copilot AI assigned Copilot and lixun910 May 9, 2026

Copilot created this pull request from a session on behalf of lixun910 May 9, 2026 21:15 View session

Copilot AI requested a review from lixun910 May 9, 2026 21:15

Copilot finished work on behalf of lixun910 May 9, 2026 21:15

Copilot started work on behalf of lixun910 May 9, 2026 21:21 View session

docs: remove resolved Windows FAQ entry from keplergl-jupyter faq.md

83698e8

Agent-Logs-Url: https://github.com/keplergl/kepler.gl/sessions/9f887b15-c6cb-4fa0-8d08-e0ac6dfc5756 Co-authored-by: lixun910 <2423887+lixun910@users.noreply.github.com>

Copilot finished work on behalf of lixun910 May 9, 2026 21:23

lixun910 approved these changes May 9, 2026

View reviewed changes

lixun910 marked this pull request as ready for review May 9, 2026 21:25

Copilot AI review requested due to automatic review settings May 9, 2026 21:25

lixun910 changed the title ~~docs: split keplergl-jupyter docs into separate sub-pages~~ docs: update keplergl-jupyter docs for v0.4.0 May 9, 2026

Copilot started reviewing on behalf of lixun910 May 9, 2026 21:25 View session

Copilot AI reviewed May 9, 2026

View reviewed changes

Comment thread docs/table-of-contents.json Outdated

Comment thread docs/keplergl-jupyter/config.md Outdated

Comment thread docs/keplergl-jupyter/widget-api.md Outdated

Comment thread docs/keplergl-jupyter/save-and-export.md Outdated

lixun910 requested review from chrisgervang and igorDykhta May 9, 2026 21:30

Copilot started work on behalf of lixun910 May 9, 2026 21:33 View session

Copilot AI requested a review from lixun910 May 9, 2026 21:35

Copilot finished work on behalf of lixun910 May 9, 2026 21:35

Copilot started work on behalf of lixun910 May 9, 2026 21:35 View session

Copilot AI and others added 7 commits May 9, 2026 21:36

docs(python): add Claude Code and Codex skill setup to README

21247d2

Agent-Logs-Url: https://github.com/keplergl/kepler.gl/sessions/515f8388-a304-4295-b4e4-cb3eab823ae9 Co-authored-by: lixun910 <2423887+lixun910@users.noreply.github.com>

docs(python): clarify Codex setup label in README

662032f

Agent-Logs-Url: https://github.com/keplergl/kepler.gl/sessions/515f8388-a304-4295-b4e4-cb3eab823ae9 Co-authored-by: lixun910 <2423887+lixun910@users.noreply.github.com>

docs(python): refine Codex README wording

9978287

Agent-Logs-Url: https://github.com/keplergl/kepler.gl/sessions/515f8388-a304-4295-b4e4-cb3eab823ae9 Co-authored-by: lixun910 <2423887+lixun910@users.noreply.github.com>

docs(python): clarify OpenAI Codex naming in README

9539497

Agent-Logs-Url: https://github.com/keplergl/kepler.gl/sessions/515f8388-a304-4295-b4e4-cb3eab823ae9 Co-authored-by: lixun910 <2423887+lixun910@users.noreply.github.com>

docs(python): use neutral Codex-compatible wording

b40016a

Agent-Logs-Url: https://github.com/keplergl/kepler.gl/sessions/515f8388-a304-4295-b4e4-cb3eab823ae9 Co-authored-by: lixun910 <2423887+lixun910@users.noreply.github.com>

docs(python): add Codex skill structure and icon asset guidance

ebdea2e

Agent-Logs-Url: https://github.com/keplergl/kepler.gl/sessions/515f8388-a304-4295-b4e4-cb3eab823ae9 Co-authored-by: lixun910 <2423887+lixun910@users.noreply.github.com>

docs(python): use repo-relative icon paths in Codex skill guide

4a06a4c

Agent-Logs-Url: https://github.com/keplergl/kepler.gl/sessions/515f8388-a304-4295-b4e4-cb3eab823ae9 Co-authored-by: lixun910 <2423887+lixun910@users.noreply.github.com>

Copilot finished work on behalf of lixun910 May 9, 2026 21:40

Copilot started work on behalf of lixun910 May 9, 2026 21:57 View session

Copilot finished work on behalf of lixun910 May 9, 2026 21:58

lixun910 requested a review from Copilot May 9, 2026 22:00

Copilot started reviewing on behalf of lixun910 May 9, 2026 22:01 View session

Copilot AI reviewed May 9, 2026

View reviewed changes

Copilot started work on behalf of lixun910 May 9, 2026 22:07 View session

Copilot finished work on behalf of lixun910 May 9, 2026 22:10

lixun910 approved these changes May 10, 2026

View reviewed changes

igorDykhta added the jupyter keplergl for Jupyter label May 25, 2026

Uh oh!

Conversation

Copilot AI commented May 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

lixun910 commented May 9, 2026

Uh oh!

Copilot AI commented May 9, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

lixun910 commented May 9, 2026

Uh oh!

Copilot AI commented May 9, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Copilot AI commented May 9, 2026 •

edited

Loading