QuantEcon / QuantEcon/quantecon-sphinx-theme
Audit and review the project: go / no-go before further work
Nobody has claimed this yet.
- Dominant language
- SCSS
- Stars
- 0
- Forks
- 0
- Avg merge
- 3h 29m
- Merged PRs (30d)
- 1
Description
This repository was built in a single session on 24 February 2026 and has not been touched since. Before anyone invests further, it deserves a deliberate audit — both of the code and of whether the project should continue at all.
Where things stand
| Created | 2026-02-24 03:16Z |
| Commits | 15, all authored 01:55–03:13 on 2026-02-24, single author |
| Branches | main only |
| Tags / releases | none |
| PRs / issues before this batch | none |
| Downstream users | none — the one evaluation, QuantEcon/lecture-python-programming#475, was closed unmerged |
| Docs | https://quantecon.github.io/quantecon-sphinx-theme/, deployed once |
The entire history was authored locally and pushed in one shot, then evaluated within the hour. Nothing has exercised it since. The known defects are tracked separately: #1 (inline math), #2 (RHS ToC), #3 (border), #4 (author/translator attribution), and #5 (positioning and name).
Scope of the audit
Strategic — answer first, since it gates the rest. Is this project still wanted? The two conflicting purposes on record (brand-neutral upstream base per PLAN.md, versus a second QuantEcon theme for non-core series per the evaluation PR) need reconciling, and the naming question depends on the answer. There is also a timing question: the QuantEcon lecture repos are migrating to Jupyter Book 2 / the MyST CLI, which changes the theming story substantially — a Sphinx theme targeting Jupyter Book ≥ 1.0, as PLAN.md specifies, may be aiming at a target that is moving out from under it. Worth confirming before writing more SCSS.
Technical, if it continues. Review the SCSS and JS structure against what quantecon-book-theme learned; check the pydata-sphinx-theme inheritance and how much is override-by-suppression (see 1a0ea07, which suppresses a duplicate pydata footer) versus genuine extension; verify accessibility claims in PLAN.md (WCAG 2.1 AA contrast, keyboard nav, reduced-motion) actually hold, since none appear to have been tested; assess docs/kitchen-sink.md coverage against real lecture content, which is what surfaced the math and ToC defects; and establish whether there is any test or visual-regression story at all.
Process, if it continues. Decide on a release process and cut a tagged version — the evaluation had to pin @ git+...@main, which is not reproducible and made it impossible to tell a stale build from a live defect. Also settle the Phase 2 scope in PLAN.md and whether the quantecon-book-theme inheritance goal is real or aspirational.
Outcome sought. A go / no-go, and if go, a short prioritised plan. If no-go, archive the repository so it does not sit in an ambiguous state — the work is recoverable from history either way.
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
Read PLAN.md first to reconcile the project’s intended purpose with the Jupyter Book 2/MyST CLI migration. Review the SCSS and JS structure, commit 1a0ea07, and docs/kitchen-sink.md against the listed defects and accessibility claims; done means a go/no-go decision with a prioritised plan, or a decision to archive the repository.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, jupyter, scss
- Domain
- documentation, tooling
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Active
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100