Skip to content

Issue 752 #963

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

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Issue 752 #963

wants to merge 4 commits into from

Conversation

benbencik
Copy link

Description

Changes

  1. Removed Duplicate Files:
    • Found identical header also in ec/doc
    • Removed duplicate katex-header.html files from both /ff/doc/ and /ec/doc/
    • Kept only the centralized version at the workspace level
  2. Fixed Macro Rendering Issues:
    • After removing duplicates, I discovered browser console errors related to custom LaTeX macros
    • Cause: The onload rendering of math expressions occurred before macro definitions were available
    • To resolve this I restructured the katex-header.html file to define the window.katex_options object before loading the auto-render script
    • Reformated katex-header.html for better readability

Verification:

  • Clean rebuild with cargo clean --doc && make doc
  • Added test LaTeX expressions to index.html in ark_ff and ark_ec documentation to verify proper rendering
  • Checked browser console for KaTeX parse errors

  • Targeted PR against correct branch (master)
  • Linked to GitHub issue with discussion and accepted design OR have an explanation in the PR that describes this work.
  • Wrote unit tests: did not write tests for docs generations instead verified by generating docs and confirming expressions render correctly
  • Updated relevant documentation in the code
  • Added a relevant changelog entry to the Pending section in CHANGELOG.md
  • Re-reviewed Files changed in the GitHub PR explorer

@benbencik benbencik requested review from a team as code owners March 27, 2025 15:52
@benbencik benbencik requested review from z-tech, Pratyush and weikengchen and removed request for a team March 27, 2025 15:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant