Legacy docs take a long time to generate
Open
Nobody has claimed this yet.
is:idea
pri:normal
- Dominant language
- SCSS
- Stars
- 6
- Forks
- 14
- Avg merge
- 13m
- Merged PRs (30d)
- 1
Description
I am not sure how to fix this, but until we added the legacy docs, the site regenerated nearly instantly as you made changes. It not takes nearly a minute. This really slows down the dev/test cycle.
We could,
- Not generate the files and use javascript to include them, similar to our current index.php javascript redirect, but do the include
- Pre-generate them and only regenerate when we change headers
- Pre-generate them with lighter docs only headers that don't change
- Figure out how to not generate them during development
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 reproducing the slow site regeneration after changing content, then inspect how the legacy docs are generated and compare that flow with the current index.php JavaScript redirect. Decide on a regeneration strategy and verify that development rebuilds return to a near-instant cycle without breaking legacy documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, php
- Domain
- build-system, documentation, performance
- Issue type
- Bug
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100