-
Notifications
You must be signed in to change notification settings - Fork 5
Prepare versioned docs for main #294
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
…re-main * origin/284-prepare-main:
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.
Pull Request Overview
This pull request streamlines versioning in the documentation and sample components by replacing dynamic version determination with a static version constant and removing legacy version handling code.
- Removed functions for determining the version from the docs, replacing them with a constant (VERSION_ID).
- Removed legacy version components (such as components for 1.x, 2.0, 2.1, 2.2, etc.).
- Updated various pages and components to reference the new VERSION_ID and static paths.
Reviewed Changes
Copilot reviewed 300 out of 305 changed files in this pull request and generated no comments.
Show a summary per file
File | Description |
---|---|
src/shares/version.ts | Replaced dynamic version functions with a static constant and added a note about a future version update. |
src/pages/index.tsx | Updated import and link paths to use the static VERSION_ID. |
src/components/samplePreviews/* | Removed older version-specific component exports and updated index references. |
src/components/docs/ComponentList.tsx, HomepageFeatures.tsx, ExampleLink.tsx | Updated version handling by removing deprecated version functions and using the static VERSION_ID. |
docusaurus.config.js | Added dropdown items for archived versions using a new PUBLIC_BASE_URL constant. |
.github/actions/build-artifacts/action.yml | Introduced a new step to download docs for version 2.2. |
Files not reviewed (5)
- package.json: Language not supported
- versioned_docs/version-1.7/00-welcome.mdx: Language not supported
- versioned_docs/version-1.7/01-manifest.mdx: Language not supported
- versioned_docs/version-1.7/03-faq.mdx: Language not supported
- versioned_docs/version-1.7/10-get-started/5-frameworks.mdx: Language not supported
Comments suppressed due to low confidence (2)
src/shares/version.ts:1
- [nitpick] Consider updating the VERSION_ID constant and its comment to clearly indicate the intended version scheme. If V3 is planned, clarify how and when the update will occur to avoid potential confusion.
export const VERSION_ID = 'v2'; // should be V3, but we don't have a V3 sample app deployed yet.
.github/actions/build-artifacts/action.yml:22
- The build step downloads docs for version 2.2 while the application code now uses a static VERSION_ID ('v2'). Ensure this version reference is consistent across both build artifacts and the deployed app to avoid version mismatches.
- name: Download Docs (2.2)
The A11y and PO reviews will only take place after all other DoD steps have been completed by the Developer: