Skip to content

Comments

Surface documentation index for AI tooling and discoverability#5834

Open
evnchn wants to merge 1 commit intozauberzeug:mainfrom
evnchn:documentation-index
Open

Surface documentation index for AI tooling and discoverability#5834
evnchn wants to merge 1 commit intozauberzeug:mainfrom
evnchn:documentation-index

Conversation

@evnchn
Copy link
Collaborator

@evnchn evnchn commented Feb 22, 2026

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:

  • Schema table describing the JSON structure (title, content, format, url, demo fields)
  • Comparison table of the three available endpoints (sitewide_index.json ~140k tokens, search_index.json ~100k tokens, examples_index.json ~3k tokens) with entry counts, token estimates, and use cases
  • Call for community contributions (MCP servers, AI agent skills, enhanced RAG implementations)

Homepage AI CTA (dark-box section between Installation and Features):

  • Headline: "Or, let your AI do it"
  • Copy highlighting that most LLMs already know NiceGUI, with a link to the documentation index for when that isn't enough
  • "Learn more" button linking to the new documentation section

Documentation overview update:

  • Added an "If you are an AI" note with a direct link to the machine-readable JSON index, so AI consumers landing on the documentation entry point can immediately find the structured data

Progress

  • I chose a meaningful title that completes the sentence: "If applied, this PR will..."
  • The implementation is complete.
  • If this PR addresses a security issue, it has been coordinated via the security advisory process.
  • Pytests have been added (or are not necessary).
  • Documentation has been added (or is not necessary).

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>
@evnchn evnchn added the documentation Type/scope: Documentation, examples and website label Feb 22, 2026
@evnchn evnchn requested a review from rodja February 22, 2026 18:18
@evnchn
Copy link
Collaborator Author

evnchn commented Feb 22, 2026

overview-ai-line documentation-index-section homepage-ai-cta

@falkoschindler falkoschindler added the review Status: PR is open and needs review label Feb 23, 2026
@falkoschindler falkoschindler added this to the 3.10 milestone Feb 23, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Type/scope: Documentation, examples and website review Status: PR is open and needs review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants