PrismarineJS / PrismarineJS/minecraft-data

Make documentation faster

Open
#973 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation enhancement
Dominant language
JavaScript
Stars
938
Forks
294
Avg merge
3d 5h
Merged PRs (30d)
25

Description

if we need to make the documentation load faster, the main thing to do is to stop using jquery datatable
as most of the time is spent in https://github.com/DataTables/DataTablesSrc/blob/7014cf2dd12427391f894e5d3c2677d8476b9b33/js/core/core.draw.js#L34

image

reimplementing with litelement + table is easy enough and would be faster

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the documentation page that uses jQuery DataTables, then inspect the linked DataTables core.draw.js hotspot and the attached performance evidence. Define the replacement boundary and verify that the documentation table remains usable and loads faster after the proposed LitElement and table implementation.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, jquery
Domain
documentation, frontend, performance
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.