POC: docs refactor #3978
Draft
POC: docs refactor #3978
Conversation
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
…ction sequencing and multi-instance support (#21) * Initial plan * Extract wireframe components and create directive Co-authored-by: kecnry <[email protected]> * Update index.html to use external wireframe components Co-authored-by: kecnry <[email protected]> * Add wireframe architecture documentation Co-authored-by: kecnry <[email protected]> * Add wireframe test page for standalone testing Co-authored-by: kecnry <[email protected]> * fix embedding issues * fix descriptions and API button * simplify cycle control button * Add customization options to wireframe directive - Add 'demo' option to customize cycling order - Add 'enable-only' option to disable specific toolbar icons - Add 'show-scroll-to' option to control footer button visibility - Configure aperture_photometry.rst to only show/enable plugins tab - Configure index.html to show all features (default) Co-authored-by: kecnry <[email protected]> * no need to explicitly set show-scroll-to: false * fix light styles * add plugin tray wireframe * Add plugin customization and demo sequencing - Add plugin-name option to customize expansion panel name - Add plugin-panel-opened option to control initial panel state - Add custom-content option to inject custom HTML (replaces description) - Add demo sequence support with actions (open-panel, select-data, select-aperture) - Configure aperture_photometry.rst with custom plugin and demo sequence - Demo: activate plugins tab -> open panel -> select "Image 2" Co-authored-by: kecnry <[email protected]> * per-plugin wireframe demo * fillout docs content * Add initial state support and multi-instance capability - Add :initial: option to set wireframe state before demo starts - Initial state applied on restart and demo repeat - Support multiple wireframe instances per page using unique IDs - Each instance has its own config via data-wireframe-config attribute - Scoped DOM queries to container to avoid conflicts - Parse initial state with same syntax as demo sequence Co-authored-by: kecnry <[email protected]> * Fix JSON encoding for wireframe config attributes - Use proper JSON encoding instead of manual string building - Escape JSON for HTML attributes using html.escape() - Build config as Python dict then serialize with json.dumps() - Fixes broken wireframe display on index.html and doc pages Co-authored-by: kecnry <[email protected]> * fix multiple instances on one page * fix changing dropdown after clicking subtab --------- Co-authored-by: copilot-swe-agent[bot] <[email protected]> Co-authored-by: kecnry <[email protected]> Co-authored-by: Kyle Conroy <[email protected]>
kecnry
force-pushed
the
docs-refactor
branch
2 times, most recently
from
1833014 to
21f6450
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Description
This pull request replaces the landing page of the docs and reorganizes content preparing for a deconfigged-first release.
Rendered docs
If merging this, we may want to change the default on readthedocs from "latest" to "stable"
Change log entry
CHANGES.rst? If you want to avoid merge conflicts,list the proposed change log here for review and add to
CHANGES.rstbefore merge. If no, maintainershould add a
no-changelog-entry-neededlabel.Checklist for package maintainer(s)
This checklist is meant to remind the package maintainer(s) who will review this pull request of some common things to look for. This list is not exhaustive.
triviallabel.cache-download.ymlworkflow?