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

Further update Optimization Detective documentation #1869

Merged
merged 7 commits into from
Feb 20, 2025
Merged

Conversation

westonruter
Copy link
Member

See #1857

@westonruter westonruter added [Type] Documentation Documentation to be added or enhanced [Plugin] Optimization Detective Issues for the Optimization Detective plugin labels Feb 13, 2025
@westonruter
Copy link
Member Author

westonruter commented Feb 13, 2025

  • Remove docs from the build.

@westonruter
Copy link
Member Author

westonruter commented Feb 16, 2025

  • Update introduction.md based on a new version drafted in a Google Doc.

Copy link

codecov bot commented Feb 16, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 66.70%. Comparing base (42bd7a8) to head (7a5bfad).
Report is 12 commits behind head on trunk.

Additional details and impacted files
@@           Coverage Diff           @@
##            trunk    #1869   +/-   ##
=======================================
  Coverage   66.70%   66.70%           
=======================================
  Files          88       88           
  Lines        7029     7029           
=======================================
  Hits         4689     4689           
  Misses       2340     2340           
Flag Coverage Δ
multisite 66.70% <ø> (ø)
single 37.20% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

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

Copy link
Member

@felixarntz felixarntz left a comment

Choose a reason for hiding this comment

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

The current contents of the Google doc look good to me to move here. There may be small quirks here or there, but we can continue to finetune over time. This is excellent documentation and should provide a lot more context on how to use the plugin.

You probably need to still update the PR with the most recent changes from the doc, but I'm going to preemptively approve based on the doc contents.

@westonruter westonruter marked this pull request as ready for review February 20, 2025 03:58
Copy link

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: westonruter <westonruter@git.wordpress.org>
Co-authored-by: felixarntz <flixos90@git.wordpress.org>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

@westonruter westonruter merged commit 2c3e1ca into trunk Feb 20, 2025
18 checks passed
@westonruter westonruter deleted the update/od-docs branch February 20, 2025 05:02
@westonruter westonruter added the skip changelog PRs that should not be mentioned in changelogs label Feb 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Plugin] Optimization Detective Issues for the Optimization Detective plugin skip changelog PRs that should not be mentioned in changelogs [Type] Documentation Documentation to be added or enhanced
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants