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

Migrate doc sites to MkDocs #1302

Merged
merged 15 commits into from
Mar 5, 2025
Merged

Migrate doc sites to MkDocs #1302

merged 15 commits into from
Mar 5, 2025

Conversation

Goooler
Copy link
Member

@Goooler Goooler commented Mar 4, 2025

https://squidfunk.github.io/mkdocs-material


  • CHANGELOG's "Unreleased" section has been updated, if applicable.

Sorry, something went wrong.

@Goooler Goooler force-pushed the g/20250304/migrate-sites branch 4 times, most recently from 6cbc426 to d8b1f72 Compare March 5, 2025 03:29
Goooler added 5 commits March 5, 2025 12:00

Verified

This commit was signed with the committer’s verified signature.
Goooler Zongle Wang
@Goooler Goooler force-pushed the g/20250304/migrate-sites branch from d8b1f72 to 984774d Compare March 5, 2025 04:02
@Goooler Goooler force-pushed the g/20250304/migrate-sites branch from f3551a5 to 01bd9eb Compare March 5, 2025 05:06
@Goooler Goooler force-pushed the g/20250304/migrate-sites branch from 7745597 to 96032ee Compare March 5, 2025 05:13
@Goooler Goooler requested a review from Copilot March 5, 2025 05:14
Copy link
Contributor

@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.

PR Overview

This PR migrates the documentation site to MkDocs, updating associated links and workflows to support this change.

  • Adds a new docs/README.md with updated MkDocs content
  • Updates changelog links and release instructions in multiple files
  • Revises the GitHub release workflow to deploy the MkDocs site

Reviewed Changes

File Description
docs/README.md New documentation page with MkDocs content
.github/workflows/release.yml Updates build steps and adds a site deployment step
README.md Adjusts changelog link to the new docs path
.github/pull_request_template.md Updates changelog link reference
RELEASING.md Updates changelog link reference

Copilot reviewed 40 out of 40 changed files in this pull request and generated 1 comment.

@Goooler
Copy link
Member Author

Goooler commented Mar 5, 2025

@Goooler Goooler marked this pull request as ready for review March 5, 2025 05:18
@Goooler Goooler enabled auto-merge (squash) March 5, 2025 05:33
@Goooler Goooler merged commit d080748 into main Mar 5, 2025
7 checks passed
@Goooler
Copy link
Member Author

Goooler commented Mar 5, 2025

/gemini review

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request migrates the documentation sites to MkDocs, a static site generator that uses Markdown files. The changes include updating file paths, removing VuePress-related files, and configuring MkDocs for deployment. Overall, the changes seem well-structured and necessary for the migration.

Summary of Findings

  • Removal of node_modules and VuePress files: The pull request removes node_modules and VuePress-related files, which is expected as part of migrating to MkDocs. This helps to clean up the repository and remove unnecessary dependencies.
  • File path updates: Several file paths are updated to reflect the new documentation structure. This ensures that links and references point to the correct locations in the MkDocs site.
  • Workflow updates: The release workflow is updated to include steps for installing MkDocs, deploying the site, and extracting release notes from the correct location. This ensures that the documentation site is automatically updated on releases.

Merge Readiness

The pull request appears to be well-structured and necessary for migrating the documentation sites to MkDocs. However, I recommend verifying that the new documentation site is functioning correctly and that all links and references are working as expected. I am unable to approve this pull request, and recommend that others review and approve this code before merging. Given that there are no critical or high severity issues, the pull request seems to be in good shape to be merged after the verification.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant