Surface documentation index for AI tooling and discoverability#5834
Open
evnchn wants to merge 1 commit intozauberzeug:mainfrom
Open
Surface documentation index for AI tooling and discoverability#5834evnchn wants to merge 1 commit intozauberzeug:mainfrom
evnchn wants to merge 1 commit intozauberzeug:mainfrom
Conversation
Surface NiceGUI's machine-readable JSON documentation endpoints (sitewide, search, examples indices) in a new documentation section under Configuration & Deployment. Add an AI-targeted CTA on the homepage linking to the index, and a note in the documentation overview for AI consumers. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Collaborator
Author
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
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.



Motivation
When developers evaluate UI libraries, AI compatibility is increasingly a deciding factor — both for direct LLM-assisted development and because AI-powered search summaries (Google AI Overview, Perplexity, ChatGPT search) now heavily influence which libraries get recommended. NiceGUI already serves its full documentation as machine-readable JSON indices, but this capability was completely undiscoverable — buried as an implementation detail with no public-facing documentation.
This should have been surfaced from day one. The indices power our own site search and are ideal for RAG pipelines, MCP servers, and AI agent tooling, yet no one could find them without reading the source code.
This PR makes the documentation index a first-class, documented feature.
Implementation
New documentation section in Configuration & Deployment:
title,content,format,url,demofields)sitewide_index.json~140k tokens,search_index.json~100k tokens,examples_index.json~3k tokens) with entry counts, token estimates, and use casesHomepage AI CTA (dark-box section between Installation and Features):
Documentation overview update:
Progress