Conversation
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Migrates the documentation site from MkDocs Material (mkdocs.yml) to Zensical (zensical.toml) and updates the CI/CD + dev tooling accordingly to build/deploy via GitHub Pages.
Changes:
- Replace MkDocs Material configuration with a new
zensical.tomlconfig and adjust markdown pages for Zensical (page front matter/icons). - Update GitHub Actions docs workflow to build with
zensical build --cleanand deploy via GitHub Pages actions. - Remove MkDocs-related editor/devcontainer settings and replace docs assets (favicon/logo) with
purse.svg.
Reviewed changes
Copilot reviewed 14 out of 18 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| zensical.toml | New Zensical site configuration (nav/theme/features/markdown extensions). |
| mkdocs.yml | Removes legacy MkDocs Material configuration. |
| docs/index.md | Adds page front matter for Zensical icon metadata. |
| docs/installation.md | Adds front matter and adjusts section heading formatting. |
| docs/guide.md | Adds front matter for icon metadata. |
| docs/performance.md | Adds front matter for icon metadata. |
| docs/philosophy.md | Adds front matter for icon metadata. |
| docs/api-reference.md | Adds front matter (title + icon). |
| docs/assets/purse.svg | Adds new SVG asset used as logo/favicon. |
| docs/assets/logo.svg | Removes old logo asset. |
| docs/assets/favicon.svg | Removes old favicon asset. |
| .vscode/settings.json | Removes MkDocs YAML schema/custom tags config. |
| .vscode/extensions.json | Removes YAML extension recommendation; keeps Luau tooling. |
| .gitignore | Renames MkDocs-specific ignore comment to generic docs wording. |
| .github/workflows/docs.yml | Switches from mkdocs gh-deploy to Zensical build + Pages deploy workflow. |
| .github/workflows/ci.yml | Minor formatting/whitespace normalization in steps. |
| .github/workflows/release.yml | Minor formatting/whitespace normalization in steps and tag pattern quoting. |
| .devcontainer/devcontainer.json | Replaces MkDocs install with Zensical install; updates forwarded port label. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Migrates the documentation from Material for MkDocs to Zensical.
MkDocs version 2 is bleak, and Material for MkDocs is no longer maintained. It's a good time to migrate to alternatives.