Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Spike: HTML format navigation improvements #3434

Open
IgnatBeresnev opened this issue Dec 21, 2023 · 0 comments
Open

Spike: HTML format navigation improvements #3434

IgnatBeresnev opened this issue Dec 21, 2023 · 0 comments
Assignees
Labels
enhancement An issue for a feature or an overall improvement format: html An issue/PR related to Dokka's default HTML output format html: frontend An issue/PR that only or primarily requires frontend work (html/css)

Comments

@IgnatBeresnev
Copy link
Member

IgnatBeresnev commented Dec 21, 2023

There are multiple problems related to navigation:

Each problem could be addressed on its own, but all of them have multiple possible solutions, and it's difficult to estimate which will be more profitable and how each solution will affect the others.

To avoid a situation where we re-write the same place three times, it might be possible to address all of these problems in one go, but it also needs to be researched and estimated.

This issue exists to track such research and answer the following questions:

Is it possible / worth it to:

  • Break down navigation.html into smaller navigation-module.json, which could be loaded independently as the user opens the navigation dropdown.
    • How difficult is it to implement, effort / time estimates
  • How should page refreshes be approached?
  • How to solve the offline mode issue, where the navigation menu is missing
    • Will breaking navigation.html into navigation-module.json help?
    • Wrapping navigation.html as a .js file - is it possible, what are the disadvantages / possible problems

The ideal output of this research is some summary of the findings in the comments.

The research is limited by time, ~ a week.

@IgnatBeresnev IgnatBeresnev added enhancement An issue for a feature or an overall improvement format: html An issue/PR related to Dokka's default HTML output format html: frontend An issue/PR that only or primarily requires frontend work (html/css) labels Dec 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement An issue for a feature or an overall improvement format: html An issue/PR related to Dokka's default HTML output format html: frontend An issue/PR that only or primarily requires frontend work (html/css)
Projects
None yet
Development

No branches or pull requests

2 participants