Skip to content

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

Merged
merged 21 commits into from
Apr 17, 2025
Merged

Prepare versioned docs for main #294

merged 21 commits into from
Apr 17, 2025

Conversation

sdvg
Copy link
Member

@sdvg sdvg commented Apr 1, 2025

The A11y and PO reviews will only take place after all other DoD steps have been completed by the Developer:

  • Meaningful pull request title for the release notes
  • Pull request is linked to an issue and all changes relate to the issue
  • Tests to protect this code implemented (if applicable)
  • Manual test performed successfully (if applicable)
  • Documentation or migration has been updated (if applicable)

@sdvg sdvg linked an issue Apr 1, 2025 that may be closed by this pull request
Copy link

github-actions bot commented Apr 1, 2025

@sdvg sdvg force-pushed the 284-prepare-main branch from 30698ce to 5141b6e Compare April 1, 2025 07:42
@sdvg sdvg marked this pull request as ready for review April 1, 2025 16:57
@sdvg sdvg requested a review from Copilot April 1, 2025 16:57
Copy link

@Copilot Copilot AI left a 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)

@deleonio deleonio marked this pull request as draft April 3, 2025 03:42
@sdvg sdvg marked this pull request as ready for review April 16, 2025 08:03
@deleonio deleonio merged commit c40939d into main Apr 17, 2025
4 checks passed
@deleonio deleonio deleted the 284-prepare-main branch April 17, 2025 01:24
@publicuibot publicuibot bot locked and limited conversation to collaborators Apr 17, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Dokumentation in verschiedenen Branches verwalten
2 participants