Repository navigation
Document TEMPLATE_DEFAULTS and buddy_sender - #3
Open
geoffreycastillo wants to merge 1 commit into
Open
geoffreycastillo wants to merge 1 commit into
geoffreycastillo wants to merge 1 commit into
Conversation
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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.
Follow-up to mrpg/uproot#285. This documents
buddy_senderand the whole ofTEMPLATE_DEFAULTS.Deploy this only after the next uproot release.
buddy_senderis not in 0.11.0, so the example inadmin.mdstops the server on that version withInvalid TEMPLATE_DEFAULTS.Changes
building/pages.mdupd.TEMPLATE_DEFAULTS, which value wins, the threebuddy_*switches, and the startup check.disable_alpinejsrow to the switches table, and clarifies a few other rows.disable_auto_startanddisable_bootstrap.running/admin.mdbuddy_label,buddy_senderandbuddy_image, plus the translation route for multilingual studies, as you suggested in the issue.building/alpinejs.md: short “Disabling Alpine.js” section.getting-started/project-structure.md: short “Template defaults” entry undermain.py.AGENTS.mddisable_auto_startanddisable_bootstrapare effectively internal. I added it because my coding agent kept wanting to document their pitfalls and explain how to rescue a study after disabling them, when disabling them is clearly just a very bad idea. The line tells future agents to warn against these switches rather than document workarounds.Question for you
Are
disable_auto_startanddisable_bootstrapstrictly internal? Is there a legitimate reason for a user to disable them?Disabling either one breaks a lot:
disable_auto_start: Next silently stops working on experiment pages, and so do live methods and chat. Set project-wide, participants never reach the first page. The only uses I found are uproot's ownRoomFull,RoomHelloandJustPOSTpages.disable_bootstrap: the modal text is visible on every page, pop-ups do not open, and sliders with a popover throw a JavaScript error. I found no use of it in the code, tests, examples or issues.To me, these look like internal switches, and I think the docs should label them as such. For now, the docs only warn against them. If you agree, I can update this PR to say so. If there is a legitimate use case, I can document that instead and adjust the
AGENTS.mdline.Testing
I checked the behaviour described here on a test project running uproot
main, using Chrome. This covered which value wins,buddy_image, the startup check, the English and German translation example, and the main things the two risky switches break. I also sent a real admin chat message withbuddy_labelandbuddy_senderset, and the new text appeared on both the admin and participant sides. The site builds withmkdocs build --strict, and I checked the internal links on the changed pages, including anchors.