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

refactor: update the main readme file #701

Merged
merged 26 commits into from
Jun 21, 2024
Merged

refactor: update the main readme file #701

merged 26 commits into from
Jun 21, 2024

Conversation

BioPhoton
Copy link
Collaborator

@BioPhoton BioPhoton commented Jun 11, 2024

This PR reworks the landing page of the open source mono repo.

  • new order of blocks
  • information on what the tool can do
  • links to other parts of our repos

@github-actions github-actions bot added the 📖 Project documentation improvements or additions to the project documentation label Jun 11, 2024
Copy link

github-actions bot commented Jun 11, 2024

Code PushUp

🤨 Code PushUp report has both improvements and regressions – compared target commit 0c5a1fd with source commit e19917f.

🏷️ Categories

🏷️ Category ⭐ Current score ⭐ Previous score 🔄 Score change
Performance 🟡 65 🟡 63 ↑ +2.5
Accessibility 🟢 100 🟢 100
Best Practices 🟢 100 🟢 100
SEO 🟡 85 🟡 85
Bug prevention 🟢 100 🟢 100
Code style 🟢 99 🟢 99
Code coverage 🟡 89 🟡 89
Security 🟢 100 🟢 100
Updates 🟡 79 🟡 79
Custom checks 🟡 67 🟡 67

🗃️ Groups

👍 1 group improved
🔌 Plugin 🗃️ Group ⭐ Current score ⭐ Previous score 🔄 Score change
Lighthouse Performance 🟡 65 🟡 63 ↑ +2.5

19 other groups are unchanged.

🛡️ Audits

👍 6 audits improved, 👎 1 audit regressed, 7 audits changed without impacting score
🔌 Plugin 🛡️ Audit 📏 Current value 📏 Previous value 🔄 Value change
Lighthouse First Contentful Paint 🟩 1.1 s 🟨 2.0 s ↓ −45 %
Lighthouse Max Potential First Input Delay 🟥 470 ms 🟥 670 ms ↓ −29 %
Lighthouse Speed Index 🟩 2.4 s 🟩 3.1 s ↓ −21 %
Lighthouse First Meaningful Paint 🟩 1.7 s 🟩 2.0 s ↓ −15 %
Lighthouse Largest Contentful Paint 🟨 2.7 s 🟨 2.8 s ↓ −4 %
Lighthouse Total Blocking Time 🟥 950 ms 🟥 930 ms ↑ +2 %
Lighthouse Time to Interactive 🟩 3.2 s 🟩 3.4 s ↓ −6 %
Lighthouse Minimizes main-thread work 🟥 3.2 s 🟥 3.8 s ↓ −14 %
Lighthouse Metrics 🟩 3181 🟩 3375 ↓ −6 %
Lighthouse Server Backend Latencies 🟩 20 ms 🟩 60 ms ↓ −72 %
Lighthouse JavaScript execution time 🟩 0.1 s 🟩 0.1 s ↑ +59 %
Lighthouse Avoids enormous network payloads 🟩 Total size was 432 KiB 🟩 Total size was 432 KiB ↓ +0 %
Lighthouse Uses efficient cache policy on static assets 🟨 11 resources found 🟨 11 resources found ↓ +0 %
Lighthouse Initial server response time was short 🟩 Root document took 10 ms 🟩 Root document took 10 ms ↓ −40 %

495 other audits are unchanged.

@BioPhoton BioPhoton marked this pull request as ready for review June 20, 2024 12:03
@BioPhoton BioPhoton changed the title refactor(docs): redo main readme refactor: redo main readme Jun 20, 2024
@BioPhoton BioPhoton changed the title refactor: redo main readme refactor: update the main readme file Jun 21, 2024
packages/cli/docs/images/code-pushup-logo.png Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
BioPhoton and others added 3 commits June 21, 2024 17:17
Co-authored-by: Matěj Chalk <34691111+matejchalk@users.noreply.github.com>
@BioPhoton BioPhoton removed the request for review from matejchalk June 21, 2024 17:10
@BioPhoton BioPhoton merged commit f8c605a into main Jun 21, 2024
16 checks passed
@BioPhoton BioPhoton deleted the redo-main-readme branch June 21, 2024 17:42
@matejchalk matejchalk mentioned this pull request Jun 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📖 Project documentation improvements or additions to the project documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants