readthedocs / readthedocs/ext-theme
Cleanup for menus and web components
Open
Nobody has claimed this yet.
Accepted
Improvement
- Dominant language
- HTML
- Stars
- 12
- Forks
- 6
- Avg merge
- 13h 25m
- Merged PRs (30d)
- 1
Description
This is a follow up to
- #532
To cut down on complexity I only did the bare minimum to test out the patterns of nested web components.
Still left is:
- Refactor readthedocs-menu-build-rebuild to use data provided CSRF token
- Refactor button and menu WC to use context API data
- Deprecate APIEventWrapper
- Listen for multiple events to kick off API request
- Restructure of includes if needed
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the earlier work in #532 and locating readthedocs-menu-build-rebuild, the button and menu web components, APIEventWrapper, and the includes mentioned in the checklist. Review how the current components obtain CSRF and context data, then verify each listed refactor, deprecation, event-handling change, and include restructure is complete.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- html
- Domain
- frontend, web-dev
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100