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: redesigned docs site #812

Merged
merged 3 commits into from
Dec 23, 2024
Merged

docs: redesigned docs site #812

merged 3 commits into from
Dec 23, 2024

Conversation

TomerFi
Copy link
Owner

@TomerFi TomerFi commented Dec 23, 2024

Description

Describe what you did and why.

  • Cleaned up README.md.
  • Removed all-contributors config (App will be removed after the merge).
  • Cleared up CONTRIBUTING.md.
  • Removed Makefile (only used a wrapper on top of poetry).
  • Added the supported devices table (Wiki will be deleted after the merge).
  • Bupmed docs generation dependencies.
  • Redesigned doc site.

Checklist

  • I have followed this repository's contributing guidelines.
  • I will adhere to the project's code of conduct.

Additional information

Screen.Recording.2024-12-23.at.10.36.58.AM.mov

Signed-off-by: Tomer Figenblat <tomer@tomfi.info>
@pull-request-size pull-request-size bot added the size: xxl Pull request has more then 1000 lines label Dec 23, 2024
@auto-me-bot auto-me-bot bot added the status: needs review Pull request needs a review label Dec 23, 2024
@TomerFi
Copy link
Owner Author

TomerFi commented Dec 23, 2024

Oops. Forgot CI is using Makefile. 🤦

Signed-off-by: Tomer Figenblat <tomer@tomfi.info>
thecode
thecode previously approved these changes Dec 23, 2024
Copy link
Collaborator

@thecode thecode left a comment

Choose a reason for hiding this comment

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

LGTM 👍

@auto-me-bot auto-me-bot bot added status: approved Pull request is approved and removed status: needs review Pull request needs a review labels Dec 23, 2024
Signed-off-by: Tomer Figenblat <tomer@tomfi.info>
@auto-me-bot auto-me-bot bot added status: review started Pull review in progress and removed status: approved Pull request is approved labels Dec 23, 2024
Copy link

Test Results

294 tests   294 ✅  2s ⏱️
  1 suites    0 💤
  1 files      0 ❌

Results for commit 5d1b4ac.

Copy link

codecov bot commented Dec 23, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.99%. Comparing base (83d1445) to head (5d1b4ac).
Report is 3 commits behind head on dev.

Additional details and impacted files
@@           Coverage Diff           @@
##              dev     #812   +/-   ##
=======================================
  Coverage   98.99%   98.99%           
=======================================
  Files          11       11           
  Lines        1293     1293           
=======================================
  Hits         1280     1280           
  Misses         13       13           

@TomerFi TomerFi requested a review from thecode December 23, 2024 17:46
@auto-me-bot auto-me-bot bot added status: approved Pull request is approved and removed status: review started Pull review in progress labels Dec 23, 2024
@TomerFi TomerFi changed the title docs: better docs docs: redesigned docs site Dec 23, 2024
@TomerFi TomerFi merged commit f8547fa into dev Dec 23, 2024
11 checks passed
@TomerFi TomerFi deleted the docs-docs branch December 23, 2024 17:49
@auto-me-bot auto-me-bot bot added status: merged Pull request merged and removed status: approved Pull request is approved labels Dec 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
size: xxl Pull request has more then 1000 lines status: merged Pull request merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants