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: add initial docs #54

Merged
merged 28 commits into from
Sep 24, 2024
Merged

docs: add initial docs #54

merged 28 commits into from
Sep 24, 2024

Conversation

Xzelsius
Copy link
Owner

@Xzelsius Xzelsius commented Jul 16, 2024

Description

Adds a VitePress based docs page.

Type of change

  • New feature (non-breaking change which adds functionality)

How has this been tested?

Manual testing using VitePress CLI

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • My changes generate no new warnings
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

@Xzelsius Xzelsius added the documentation Improvements or additions to documentation label Jul 16, 2024
Copy link

codecov bot commented Jul 16, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.33%. Comparing base (0f7772e) to head (538bcf9).
Report is 42 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #54   +/-   ##
=======================================
  Coverage   93.33%   93.33%           
=======================================
  Files          16       16           
  Lines         225      225           
  Branches        9        9           
=======================================
  Hits          210      210           
  Misses         13       13           
  Partials        2        2           

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

@Xzelsius Xzelsius enabled auto-merge (squash) September 24, 2024 19:47
@Xzelsius Xzelsius disabled auto-merge September 24, 2024 19:48
@Xzelsius Xzelsius merged commit 57e4f5c into main Sep 24, 2024
7 checks passed
@Xzelsius Xzelsius deleted the feature/docs branch September 24, 2024 19:48
@Xzelsius Xzelsius added the enhancement New feature or request label Sep 24, 2024
@Xzelsius Xzelsius added the feature: nuke Related to the NUKE build Features label Oct 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request feature: nuke Related to the NUKE build Features
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant