Provide NiceGUI documentation in a GPT-friendly format (e.g. PDF or HTML)

[cleesmith]

I know that NiceGUI documention is provided via NiceGUI itself, but is it possible to get that as a PDF or static HTML files?
The reason I ask is that it would be helpful for usage with both OpenAI, Anthropic, and other AI's when using AI chat to
assist with coding. At this point in time, Jul 28, 2024, none of the AI's seem well trained on the NiceGUI documentation (even the ones that can search the internet) ... unless specific parts of the doc's are copied/pasted directly into the AI chat. They get close and are helpful, but often they make assumptions when they don't know, and I think they would do a better job if they had the entire doc's.
Is this possible to provide a PDF or just static HTML files? (of course, that would lack the running example code)
By the way, I am enjoying using NiceGUI so far, much better than wxPython for me ... thanks for that.

[falkoschindler]

Regarding the documentation in PDF format, there are already discussions #3165 and #1571. And there is #1371 related to GPTs.

But let's keep this discussion open for the sake of generating a GPT-friendly documentation. There is a registry we could exploit to export the documentation in a different format:

nicegui/website/documentation/content/doc/api.py

Line 18 in f22690a

registry: Dict[str, DocumentationPage] = {}

[cleesmith]

Perhaps using Playwright in python with the Chromium option is a simple way to crawl
the pages and save them as one or more PDF files.

While testing this idea ...

I noticed a bad link on page:

https://nicegui.io/documentation/storage

Storing UI state
Storage can also be used in combination with bindings. Here we are storing the value of a textarea between visits. The note is also shared between all tabs of the same user.

the "with bindings" link is https://nicegui.io/documentation/bindings
HTTPException: 404: documentation for "bindings" could not be found
... but should be:
https://nicegui.io/documentation/section_binding_properties

Thanks and still enjoying NiceGUI while "teaching" AI's to help me code my app ... a repeat project formerly in wxPython, but NiceGUI looks way cooler/modern.

[falkoschindler]

Thanks for spotting the bad link! I quickly fixed it in b1ba313. Will be online with the next release.

[cleesmith]

I created a free open source repo of scripts to allow the creation of text/pdf files based on NiceGUI's locally run website server, see:

NiceGUI-primer

I used it to create the "knowledge base" text file for a GPT on ChatGPT, which has been helpful for learning and coding.

All credits and kudos to the NiceGUI project, thanks.

[ruiheng]

Hi everyone,

I've created a Python project to scrape the NiceGUI documentation (https://nicegui.io/documentation) and consolidate it into a single Markdown file, making it easier for offline reference or AI processing. The project was generated with assistance from Grok 3 and is designed to be simple, open-source, and easy to use.

Source code: https://github.com/ruiheng/nicegui_doc_scraper

Key features:

• Uses Playwright to handle dynamically rendered pages.
• Saves individual HTML files for debugging.
• Merges content into a single, AI-friendly Markdown file (nicegui_documentation.md).
• Modular and customizable for further tweaks.

I've attached the resulting nicegui_documentation.md file for reference.

Feel free to check out the project, contribute, or let me know if you have suggestions for improvements. Hope this is helpful!
nicegui_documentation.md.zip

[evnchn]

Burning question: can this fit in the context window?

I don't think it can, because it's very long, so I'm thinking we can segment the markdown by pages, and offer, in MCP or function calling, a tool for the LLM to do a vector search, returning the top N pages which are relevant.

[ruiheng]

The md file is too large for context window, but you can use it as a knowledge base for AI to reference. For example, in POE, you can create a bot, and upload this md file to its knowledge base. In Grok, you can create a workspace, and attach this md file in it. Other AI platforms probably have this similar feature.