Skip to content

updates vitepress config #1135

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

Merged
merged 6 commits into from
Apr 5, 2025
Merged

Conversation

lazarusA
Copy link
Contributor

@lazarusA lazarusA commented Apr 5, 2025

this PR only deals with updating the docs pages.

  • latest npm package.json list packages
  • adds favicon
  • fixes to sidebar syntax (using documented way of adding multiple sidebars)
  • GitHub icon with GitHub stars
  • Enhanced Readabilities menu (introduced in the latest DVPress update)
  • use of default css files
  • use default versionPicker (removes the old one)
  • simplifies make.jl since pages is actually being done at the config.mts level.
  • Dead links (some) NOTE that upstream links from Dialects will be overwritten. Ignore for now, until a better solution or strategy is envisioned.

@lazarusA
Copy link
Contributor Author

lazarusA commented Apr 5, 2025

WIP:

Screenshot 2025-04-05 at 11 43 35

Copy link

codecov bot commented Apr 5, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 42.85%. Comparing base (b6ffc96) to head (f91dcf4).
Report is 797 commits behind head on main.

Additional details and impacted files
@@             Coverage Diff             @@
##             main    #1135       +/-   ##
===========================================
+ Coverage   21.66%   42.85%   +21.18%     
===========================================
  Files          46      110       +64     
  Lines        8048    19436    +11388     
===========================================
+ Hits         1744     8329     +6585     
- Misses       6304    11107     +4803     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.


ignoreDeadLinks: true, // tested in Documenter.jl directly

ignoreDeadLinks: false, // tested in Documenter.jl directly
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the dead links are coming from the auto-generated MLIR Dialects files, lets ignore them for the time being

Copy link
Contributor Author

@lazarusA lazarusA Apr 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

too late 😢, I almost finish the update.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done! from my side, things should work now.

Please, if comments for small details, please commit/suggest here directly 😄 .

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unfortunately, any changes to the Dialects directory will be overwritten by the automatic CI 😢. The links come from upstream packages which we have limited control over

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

that doesn't sound ideal. But, surely(?) that automatic step doesn't happened every time, we should be able to fix this, specially the links, otherwise this will be broken always.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it does, every 24 hr the CI runs, fetches code from upstream (we live on the master branch of pretty much all upstream repositories so updates are very frequent), and if there is a diff overwrites the version on main.

We could try to write an automatic mapping from auto-generated links to the correct link, but that sounds like a lot of effort and needs to be done separately for each dialect

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

uff, ok, got it! setting ignore deadinks to true for when things get overwritten and dead links are back. Otherwise, things should work.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah its about to be auto overwritten here: #1139

coming from

run: julia --project=. --color=yes make-bindings.jl

from

build_file(joinpath(src_dir, "mlir", "Dialects", file))

autogenerated via https://github.com/EnzymeAD/Reactant.jl/blob/2ba8da2991f5ddaa7aa03514b1cd47134b2b3b1d/deps/ReactantExtra/tblgen/jl-generators.cc

if you want to help add support for the actual url that would be amazing!

@avik-pal avik-pal merged commit 7275993 into EnzymeAD:main Apr 5, 2025
57 checks passed
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.

3 participants