Qiskit / Qiskit/documentation

Consolidate pages render check into Katex check

Open
#3,449 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

infra 🏗️ tech debt 💩
Dominant language
Jupyter Notebook
Stars
106
Forks
223
Avg merge
1d 8h
Merged PRs (30d)
72

Description

https://github.com/Qiskit/documentation/pull/3408 adds a new check for long math expressions. It runs over all changed files. It's similar to our pages render check in running over changed files and using ./start for a live preview of the app.

In CI, it's inefficient to run both checks because the Katex check is more powerful and could replace the pages render check. We could ensure that Playwright is checking the page 200-ed, i.e. loaded correctly. If it didn't load correctly, our Katex check should have a helpful error message.

We maybe want to keep the pages render check in general because it can be helpful to run locally and is presumably faster than our Playwright check. Although we could decide to remove it.

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

Inspect the existing pages render check and Katex check in the CI configuration, then review how each runs over changed files and uses ./start. Determine whether the Playwright check can replace the pages render check while reporting page-load failures clearly. Done means the CI checks are consolidated without losing the useful local pages render workflow.

Written by the indexing model from the issue text.

Assessment

Tech stack
playwright
Domain
ci-cd, testing-qa
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.