-
Notifications
You must be signed in to change notification settings - Fork 133
added the version list for docs on master #1309
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
Conversation
WalkthroughIntroduces a new static JavaScript file defining a global DOCUMENTATION_VERSIONS object with DEFAULTS (has_targets: false, supported_targets: ["esp32"]) and VERSIONS entries ("latest" and "release-v4.0.0" marked pre_release). Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches
🧪 Generate unit tests
Tip 👮 Agentic pre-merge checks are now available in preview!Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.
Please see the documentation for more information. Example: reviews:
pre_merge_checks:
custom_checks:
- name: "Undocumented Breaking Changes"
mode: "warning"
instructions: |
Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).Please share your feedback with us on this Discord post. 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. Comment |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (3)
docs/_static/docs_version.js (3)
9-9: Freeze the global to avoid accidental mutation at runtime.Add a freeze after initialization (keeps current
varsemantics to avoid theme breakage).Apply this diff:
-}; +}; +Object.freeze(DOCUMENTATION_VERSIONS);
2-4: Clarify has_targets vs supported_targets.If the docs don’t expose per‑target UI (
has_targets: false), consider droppingsupported_targetsto avoid confusion.Apply this diff:
- DEFAULTS: { has_targets: false, - supported_targets: [ "esp32" ] - }, + DEFAULTS: { has_targets: false },
1-1: Add repo-standard license header.Most Espressif docs assets carry an Apache‑2.0 SPDX header. Align this file with the repo’s convention.
Example:
+/* SPDX-License-Identifier: Apache-2.0 */
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/_static/docs_version.js(1 hunks)
⏰ 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). (3)
- GitHub Check: build_windows
- GitHub Check: build_macos
- GitHub Check: build
🔇 Additional comments (3)
docs/_static/docs_version.js (3)
1-9: LGTM: minimal version switcher config matches PR intent.Adds "latest" and "release-v4.0.0" with sensible DEFAULTS. No blocking issues.
1-9: Resolved — theme injects docs_version.js; no change required.
docs/conf_common.py sets html_static_path = ['../_static'] and versions_url = './_static/docs_version.js', so the theme will load docs/_static/docs_version.js (no html_js_files edit needed).
6-8: Verify version slug and pre_release flag.
- docs/_static/docs_version.js currently contains:
{ name: "latest" }, { name: "release-v4.0.0", pre_release: true } ]
- Confirm the published docs are served under the exact slug "release-v4.0.0" (output directory must match). If v4.0.0 is a final release, set pre_release: false or remove the flag.
sigmaaa
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
|
I'm skeptical that this approach will work unless we move the docs. We will merge and see |
Versions file for master added
Summary by CodeRabbit