Skip to content
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

docs: setup mkdocs-material #13

Merged
merged 26 commits into from
Feb 7, 2025
Merged

docs: setup mkdocs-material #13

merged 26 commits into from
Feb 7, 2025

Conversation

hadrien
Copy link
Owner

@hadrien hadrien commented Jan 28, 2025

Problem

  • There is no documentation which does not make the project appealing.

Solution

  • Setup mkdocs-material
  • Document :all-the-things:

Copy link

codecov bot commented Jan 28, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (4e58835) to head (b0c0516).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main       #13   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            1         1           
  Lines           93        95    +2     
  Branches         6         6           
=========================================
+ Hits            93        95    +2     

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

@hadrien hadrien merged commit c8367fc into main Feb 7, 2025
4 checks passed
@hadrien hadrien deleted the docs/mkdocs branch February 7, 2025 20:53
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