Skip to content

Conversation

@evnchn
Copy link
Collaborator

@evnchn evnchn commented Oct 17, 2025

Motivation

We can't talk about not using the script mode in #5297, if we did not document what that even is.

Implementation

Add a small section on what is script mode in the documentation.

Progress

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

@evnchn evnchn added the documentation Type/scope: Documentation, examples and website label Oct 17, 2025
@falkoschindler
Copy link
Contributor

Thanks, @evnchn!
But you're referring to the root function, which is also not explicitly documented. This is an open task on #5109.
@rodja Are you still planning to write a section about the root parameter? If so, we should coordinate our efforts.

@rodja
Copy link
Member

rodja commented Oct 18, 2025

Yes, root pages must also get better documentation. I took a first step with #5275. If that is through I want to update examples and also some of the demos where @ui.page is currently used. I think this can be an independent, and useful PR.

@falkoschindler falkoschindler added the review Status: PR is open and needs review label Oct 20, 2025
@falkoschindler falkoschindler added this to the 3.1 milestone Oct 20, 2025
@falkoschindler falkoschindler merged commit 3a94186 into zauberzeug:main Oct 20, 2025
1 check passed
@evnchn evnchn deleted the document-script-mode branch October 20, 2025 15:35
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.

3 participants