Add API docs section and llms.txt to GitHub Pages - #2
Merged
Conversation
Document the dash-globe Python API on the docs site, add markdown siblings for agents, and publish an llms.txt entry point per llmstxt.org. Co-authored-by: Jeff <jeffgallini@users.noreply.github.com>
jeffgallini
marked this pull request as ready for review
September 2, 2026 22:08
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
Adds an API section to the GitHub Pages docs covering how to use the
dash-globePython package, plus anllms.txtentry point for agents.Changes
docs/api.htmlPython API reference (scene helpers, layers, large-data, helpers, events)docs/llms.txtcurated agent map linking to markdown docsapi.md,getting-started.md,examples.md,index.md) for LLM-friendly consumptionrel="alternate"/rel="describedby"link relationsdocs/assets/site.cssPreview
After merge/deploy: https://jeffgallini.github.io/dash-globe/api.html and https://jeffgallini.github.io/dash-globe/llms.txt