Skip to content

Update sidebar labels and positioning in release docs #60243

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

Open
wants to merge 1 commit into
base: trunk
Choose a base branch
from

Conversation

joshuatf
Copy link
Contributor

@joshuatf joshuatf commented Aug 7, 2025

Changes proposed in this Pull Request:

Updates the sidebar labels so there aren't duplicates and reorders them so that they match the release docs index page order.

Screenshots or screen recordings:

Before After
image Screenshot 2025-08-07 at 9 10 04 AM

How to test the changes in this Pull Request:

Using the WooCommerce Testing Instructions Guide, include your detailed testing instructions:

  1. Navigate to the docutools folder docs/_docu-tools
  2. npm i && npm start
  3. Check that there aren't any duplicate menu items under Contribution -> Releases
  4. Check that order of sidebar items matches that at http://localhost:3000/docs/contribution/releases/

Testing that has already taken place:

Changelog entry

  • Automatically create a changelog entry from the details below.
  • This Pull Request does not require a changelog entry. (Comment required below)
Changelog Entry Details

Significance

  • Patch
  • Minor
  • Major

Type

  • Fix - Fixes an existing bug
  • Add - Adds functionality
  • Update - Update existing functionality
  • Dev - Development related task
  • Tweak - A minor adjustment to the codebase
  • Performance - Address performance issues
  • Enhancement - Improvement to existing functionality

Message

Changelog Entry Comment

Comment

@joshuatf joshuatf requested a review from a team August 7, 2025 07:14
@joshuatf joshuatf self-assigned this Aug 7, 2025
@joshuatf joshuatf requested review from prettyboymp and removed request for a team August 7, 2025 07:14
@joshuatf joshuatf requested a review from a team as a code owner August 7, 2025 07:14
@github-actions github-actions bot added the Documentation Issues and PRs related to improving documentation label Aug 7, 2025
Copy link
Contributor

github-actions bot commented Aug 7, 2025

Testing Guidelines

Hi @prettyboymp @woocommerce/developer-advocacy @woocommerce/flux,

Apart from reviewing the code changes, please make sure to review the testing instructions (Guide) and verify that relevant tests (E2E, Unit, Integration, etc.) have been added or updated as needed.

Reminder: PR reviewers are required to document testing performed. This includes:

  • 🖼️ Screenshots or screen recordings.
  • 📝 List of functionality tested / steps followed.
  • 🌐 Site details (environment attributes such as hosting type, plugins, theme, store size, store age, and relevant settings).
  • 🔍 Any analysis performed, such as assessing potential impacts on environment attributes and other plugins, conducting performance profiling, or using LLM/AI-based analysis.

⚠️ Within the testing details you provide, please ensure that no sensitive information (such as API keys, passwords, user data, etc.) is included in this public issue.

@woocommercebot woocommercebot requested a review from a team August 7, 2025 07:14
Copy link
Contributor

coderabbitai bot commented Aug 7, 2025

📝 Walkthrough

Walkthrough

This change updates the front matter metadata in several release-related documentation files by adding or modifying sidebar_position and, in one case, updating the sidebar_label. These changes affect the ordering and labeling of documentation pages in the sidebar navigation, without altering any document content or logic.

Changes

Cohort / File(s) Change Summary
Sidebar Position Metadata Addition
docs/contribution/releases/backporting.md, docs/contribution/releases/building-and-publishing.md, docs/contribution/releases/monitoring.md, docs/contribution/releases/point-releases.md, docs/contribution/releases/rc.md, docs/contribution/releases/schedule.md
Added or updated the sidebar_position field in the front matter to control sidebar ordering.
Sidebar Label Update
docs/contribution/releases/point-release-fixes.md
Changed sidebar_label from "Point Releases" to "Point Release Requests" and added sidebar_position.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

  • [release] Documentation: release schedule #58981: The main PR adds sidebar positioning metadata to multiple release-related documentation files, including schedule.md, while the retrieved PR introduces the schedule.md file itself and modifies link order in the release README; thus, the main PR’s changes directly relate to the file introduced and referenced in the retrieved PR.

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.


📜 Recent review details

Configuration used: .coderabbit.yml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 75243c4 and 3824503.

📒 Files selected for processing (7)
  • docs/contribution/releases/backporting.md (1 hunks)
  • docs/contribution/releases/building-and-publishing.md (1 hunks)
  • docs/contribution/releases/monitoring.md (1 hunks)
  • docs/contribution/releases/point-release-fixes.md (1 hunks)
  • docs/contribution/releases/point-releases.md (1 hunks)
  • docs/contribution/releases/rc.md (1 hunks)
  • docs/contribution/releases/schedule.md (1 hunks)
🧰 Additional context used
🧠 Learnings (10)
📓 Common learnings
Learnt from: CR
PR: woocommerce/woocommerce#0
File: .cursor/rules/generate-pr-description.mdc:0-0
Timestamp: 2025-07-21T05:22:46.426Z
Learning: Provide clear, step-by-step instructions for how to test the changes in the PR description.
Learnt from: jorgeatorres
PR: woocommerce/woocommerce#59675
File: .github/workflows/release-bump-as-requirement.yml:48-65
Timestamp: 2025-07-15T15:39:21.856Z
Learning: In WooCommerce core repository, changelog entries for all PRs live in `plugins/woocommerce/changelog/` directory and are processed during releases, not at the repository root level.
Learnt from: CR
PR: woocommerce/woocommerce#0
File: .cursor/rules/generate-pr-description.mdc:0-0
Timestamp: 2025-07-21T05:22:46.426Z
Learning: Applies to .github/PULL_REQUEST_TEMPLATE.md : The changelog section in the PR description must keep the markdown structure from the PR template exactly as-is, including all checkboxes, comments, and headings. Only the appropriate checkbox may be checked, and the changelog message must be placed under the `#### Comment` heading and before the closing `</details>` tag. Do not add, remove, or reformat any part of the changelog section except for checking the box and adding the message in the correct place.
Learnt from: CR
PR: woocommerce/woocommerce#0
File: .cursor/rules/generate-pr-description.mdc:0-0
Timestamp: 2025-07-21T05:22:46.426Z
Learning: Applies to .github/PULL_REQUEST_TEMPLATE.md : Preserve required markdown sections in the PR description, especially those used by automation (e.g., changelog entry details and comments). Do not remove or alter them.
📚 Learning: in woocommerce core repository, changelog entries for all prs live in `plugins/woocommerce/changelog...
Learnt from: jorgeatorres
PR: woocommerce/woocommerce#59675
File: .github/workflows/release-bump-as-requirement.yml:48-65
Timestamp: 2025-07-15T15:39:21.856Z
Learning: In WooCommerce core repository, changelog entries for all PRs live in `plugins/woocommerce/changelog/` directory and are processed during releases, not at the repository root level.

Applied to files:

  • docs/contribution/releases/schedule.md
  • docs/contribution/releases/monitoring.md
  • docs/contribution/releases/point-release-fixes.md
  • docs/contribution/releases/backporting.md
  • docs/contribution/releases/rc.md
  • docs/contribution/releases/point-releases.md
📚 Learning: woocommerce uses wordpress versioning conventions where minor versions in x.y.z format are constrain...
Learnt from: prettyboymp
PR: woocommerce/woocommerce#59048
File: .github/workflows/cherry-pick-milestoned-prs.yml:60-83
Timestamp: 2025-06-26T12:45:40.709Z
Learning: WooCommerce uses WordPress versioning conventions where minor versions in X.Y.Z format are constrained to 0-9 (Y cannot exceed 9). This means version increment logic should reset minor to 0 and increment major when minor reaches 9, rather than allowing two-digit minor versions like 9.10 or 9.11.

Applied to files:

  • docs/contribution/releases/schedule.md
  • docs/contribution/releases/monitoring.md
  • docs/contribution/releases/point-release-fixes.md
  • docs/contribution/releases/backporting.md
  • docs/contribution/releases/point-releases.md
📚 Learning: action scheduler is bundled into woocommerce and always available, so there's no need to add fallbac...
Learnt from: senadir
PR: woocommerce/woocommerce#59325
File: plugins/woocommerce/includes/wc-formatting-functions.php:1211-1226
Timestamp: 2025-07-01T16:24:23.871Z
Learning: Action Scheduler is bundled into WooCommerce and always available, so there's no need to add fallback logic to WordPress cron functions when using Action Scheduler functions like as_schedule_single_action() and as_unschedule_all_actions() in WooCommerce code.

Applied to files:

  • docs/contribution/releases/schedule.md
📚 Learning: woocommerce is currently in the midst of an admin redesign project, so temporary/short-term css solu...
Learnt from: nerrad
PR: woocommerce/woocommerce#60176
File: plugins/woocommerce/client/legacy/css/admin.scss:9088-9105
Timestamp: 2025-08-04T00:21:51.440Z
Learning: WooCommerce is currently in the midst of an admin redesign project, so temporary/short-term CSS solutions for admin pages are preferred over long-term refactoring when addressing immediate needs.

Applied to files:

  • docs/contribution/releases/schedule.md
  • docs/contribution/releases/point-release-fixes.md
  • docs/contribution/releases/backporting.md
  • docs/contribution/releases/rc.md
📚 Learning: in woocommerce blocks, when porting existing code patterns that have known issues (like parseint tru...
Learnt from: samueljseay
PR: woocommerce/woocommerce#58716
File: plugins/woocommerce/client/blocks/assets/js/blocks/mini-cart/iapi-frontend.ts:83-101
Timestamp: 2025-06-17T07:07:53.443Z
Learning: In WooCommerce blocks, when porting existing code patterns that have known issues (like parseInt truncating decimal money values), maintain consistency with existing implementation rather than making isolated fixes. The preference is for systematic refactoring approaches (like broader Dinero adoption) over piecemeal changes.

Applied to files:

  • docs/contribution/releases/backporting.md
📚 Learning: woocommerce uses autoprefixer in their postcss configuration (plugins/woocommerce/client/blocks/post...
Learnt from: Aljullu
PR: woocommerce/woocommerce#59370
File: plugins/woocommerce/client/blocks/assets/js/blocks/product-gallery/style.scss:206-233
Timestamp: 2025-07-03T10:08:59.936Z
Learning: WooCommerce uses Autoprefixer in their PostCSS configuration (plugins/woocommerce/client/blocks/postcss.config.js) with WordPress' standard browserslist configuration (wordpress/browserslist-config) to automatically add vendor prefixes like -webkit-mask-image based on supported browsers, eliminating the need for manual prefix additions.

Applied to files:

  • docs/contribution/releases/backporting.md
📚 Learning: in woocommerce blocks css, prefer using standard css properties like `scrollbar-width` over vendor-s...
Learnt from: Aljullu
PR: woocommerce/woocommerce#59370
File: plugins/woocommerce/client/blocks/assets/js/blocks/product-gallery/style.scss:236-243
Timestamp: 2025-07-03T10:09:20.635Z
Learning: In WooCommerce blocks CSS, prefer using standard CSS properties like `scrollbar-width` over vendor-specific prefixes when the standard property has good browser support. As of late 2024, `scrollbar-width` is widely supported across all major browsers and doesn't require WebKit-specific workarounds.

Applied to files:

  • docs/contribution/releases/backporting.md
📚 Learning: woocommerce legacy javascript files in plugins/woocommerce/client/legacy/js/ must use older javascri...
Learnt from: opr
PR: woocommerce/woocommerce#0
File: :0-0
Timestamp: 2025-06-20T17:38:16.565Z
Learning: WooCommerce legacy JavaScript files in plugins/woocommerce/client/legacy/js/ must use older JavaScript syntax and cannot use modern features like optional chaining (?.) due to browser compatibility requirements. Explicit null checking with && operators should be used instead.

Applied to files:

  • docs/contribution/releases/backporting.md
📚 Learning: woocommerce trunk versions follow the pattern `x.y.0-dev` where the patch version is always `0`. thi...
Learnt from: jorgeatorres
PR: woocommerce/woocommerce#59946
File: .github/workflows/release-code-freeze.yml:108-124
Timestamp: 2025-07-23T19:42:10.564Z
Learning: WooCommerce trunk versions follow the pattern `X.Y.0-dev` where the patch version is always `0`. This means when calculating release branches, string operations like `slice(0, -2)` on the version after removing `-dev` will always work correctly since the input format is predictable (e.g., `10.2.0` → `10.2`).

Applied to files:

  • docs/contribution/releases/point-releases.md
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: Validate markdown
🔇 Additional comments (7)
docs/contribution/releases/building-and-publishing.md (1)

4-4: Sidebar ordering metadata looks correct

sidebar_position: 1 is valid YAML and clearly establishes this page as the first item in the “Releases” sidebar.

docs/contribution/releases/point-releases.md (1)

4-4: Consistent positioning – LGTM

Position 2 keeps the order contiguous after “Building and Publishing”.

docs/contribution/releases/rc.md (1)

4-4: Verified: All sidebar_position values are unique
Ran a deduplication check across docs/contribution/releases, and each file holds a distinct numeric position (1–7). No duplicates found—sidebar ordering is safe.

docs/contribution/releases/schedule.md (1)

4-4: Position metadata conforms to sequence

sidebar_position: 6 correctly follows the RC page.

docs/contribution/releases/monitoring.md (1)

4-4: Final slot in series confirmed

Position 7 completes the contiguous 1-7 run introduced across the release docs.

docs/contribution/releases/backporting.md (1)

4-4: Front-matter looks correct & consistent.

sidebar_position: 3 slots this page between “Point Releases” (2) and “Point Release Requests” (4); that matches the sequence described in the PR. No further action required.

docs/contribution/releases/point-release-fixes.md (1)

3-4: All sidebar positions in docs/contribution/releases are unique

Ran a check across all markdown files and confirmed sidebar_position values 1–7 appear exactly once (no duplicates). No further updates needed.

✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch update/release-docs-sidebar-meta

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@albarin
Copy link
Contributor

albarin commented Aug 7, 2025

@joshuatf, the changes look good. I noticed the sections in the sidebar have different titles than the ones in the Release overview section (/docs/contribution/releases/). Should we make them the same?
Screenshot 2025-08-07 at 09 37 55

Copy link
Contributor

@prettyboymp prettyboymp left a comment

Choose a reason for hiding this comment

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

Other than @albarin's feedback, everything looks good.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Issues and PRs related to improving documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants