eli64s / readme-ai

README file generator, powered by large language model APIs 👾
MIT License
1.34k stars 143 forks source link

Deployment Setup for MkDocs Documentation Site #87

Closed eli64s closed 5 months ago

eli64s commented 5 months ago

Summary

This pull request brings several updates to the MkDocs documentation site, along with setup for automated deployment.

Key Changes

  1. Markdown Files Update: Revised and updated various markdown files in the docs directory to enhance the quality and comprehensiveness of documentation.

  2. Custom Styling and Scripting: Added custom CSS and JavaScript scripts to integrate with MkDocs site.

  3. Dependency Management: Updated the poetry documentation dependencies in pyproject.toml.

  4. GitHub Actions for Automated Deployment: Add GitHub Actions workflow to automate documentation site building and deploying to GitHub Pages.

codecov-commenter commented 5 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Comparison is base (3beb6da) 88.84% compared to head (dc9dda6) 89.06%.

:exclamation: Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #87 +/- ## ========================================== + Coverage 88.84% 89.06% +0.21% ========================================== Files 29 29 Lines 1372 1372 ========================================== + Hits 1219 1222 +3 + Misses 153 150 -3 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.