Starlight integration#1
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request migrates the documentation site to use the @astrojs/starlight integration, removing custom layouts, styles, and the src/content/docs submodule in the process. It also introduces a shell.nix environment and a new logo asset. Feedback focuses on correcting the GitHub social link to point to the official organization repository, configuring the new logo in the Starlight integration, adding pnpm to the Nix shell packages, and addressing potential build errors caused by the lack of documentation files and obsolete routing components.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
| starlight({ | ||
| title: 'Docs', | ||
| favicon: '/favicon.svg', | ||
| social: [{ icon: 'github', label: 'GitHub', href: 'https://github.com/TheLazyCat00' }], |
There was a problem hiding this comment.
The social link for GitHub points to a personal profile (TheLazyCat00) instead of the official organization repository (zane-lang). It should be updated to point to the organization's GitHub page.
| social: [{ icon: 'github', label: 'GitHub', href: 'https://github.com/TheLazyCat00' }], | |
| social: [{ icon: 'github', label: 'GitHub', href: 'https://github.com/zane-lang' }], |
| title: 'Docs', | ||
| favicon: '/favicon.svg', |
There was a problem hiding this comment.
The PR description mentions switching default images to the Zane logo (zane-black.svg), but the logo is not configured in the Starlight integration. Additionally, the title can be updated to 'Zane' or 'Zane Docs' to reflect the project name.
title: 'Zane',
logo: {
src: './src/assets/zane-black.svg',
},
favicon: '/favicon.svg',| packages = with pkgs; [ | ||
| nodejs | ||
| ]; |
There was a problem hiding this comment.
Since the project uses pnpm (as indicated by the .gitignore configuration), it would be beneficial to include pnpm in the shell.nix packages list so that developers using Nix have the correct package manager available automatically.
packages = with pkgs; [
nodejs
pnpm
];
| description: z.string().optional(), | ||
| }), | ||
| }), | ||
| docs: defineCollection({ loader: docsLoader(), schema: docsSchema() }), |
There was a problem hiding this comment.
With the removal of the src/content/docs submodule, there are currently no documentation files (markdown/MDX) in the repository. Starlight requires at least a home page (e.g., index.md or index.mdx) under the docs directory to build successfully and avoid routing errors.
Additionally, since Starlight handles routing and layouts automatically, old routing components like src/components/DocPage.astro (which still references the deleted DocsLayout.astro) are now obsolete and should be removed to prevent compilation errors.
|
i think we should just stick to devbox. |
|
nvm, never had devbox |
The README now specify how to run the website locally while the config file now better reflect our branding. Custom CSS file from previous website couldn't be kept as they rendered poorly with starlight. A dedicated favicons folders has been added for convenience under public/.
|
|
/gemini review |
There was a problem hiding this comment.
Code Review
This pull request migrates the website to use Astro's Starlight integration for documentation, removing custom layouts, components, and Sass styles. Feedback on these changes includes fixing a typo in the README, correcting the favicon and GitHub social link in astro.config.mjs to point to the correct project assets and organization, configuring the empty fields and missing icons in site.webmanifest, and removing now-unused dependencies like lucide-astro and sass.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
| starlight({ | ||
| title: 'Zane Docs', | ||
| description: 'The Zane programming language', | ||
| favicon: '/favicons/favicon.ico', |
There was a problem hiding this comment.
The configured favicon path /favicons/favicon.ico does not exist in the repository. Please update it to point to an existing file, such as /favicons/zane-colorised.svg.
| favicon: '/favicons/favicon.ico', | |
| favicon: '/favicons/zane-colorised.svg', |
| npm install | ||
| ``` | ||
|
|
||
| If everything went well you shoulb be able to deploy the website locally with: |
There was a problem hiding this comment.
There is a typo in this line: 'shoulb' should be 'should'.
| If everything went well you shoulb be able to deploy the website locally with: | |
| If everything went well you should be able to deploy the website locally with: |
| src: './src/assets/zane-black.svg', | ||
| alt: 'Black version of Zane logo', | ||
| }, | ||
| social: [{ icon: 'github', label: 'GitHub', href: 'https://github.com/TheLazyCat00' }], |
There was a problem hiding this comment.
The GitHub social link currently points to a personal profile (TheLazyCat00) instead of the official Zane organization (zane-lang). Please update this to point to the official repository or organization.
| social: [{ icon: 'github', label: 'GitHub', href: 'https://github.com/TheLazyCat00' }], | |
| social: [{ icon: 'github', label: 'GitHub', href: 'https://github.com/zane-lang' }], |
| @@ -0,0 +1 @@ | |||
| {"name":"","short_name":"","icons":[{"src":"/android-chrome-192x192.png","sizes":"192x192","type":"image/png"},{"src":"/android-chrome-512x512.png","sizes":"512x512","type":"image/png"}],"theme_color":"#ffffff","background_color":"#ffffff","display":"standalone"} No newline at end of file | |||
There was a problem hiding this comment.
The webmanifest file contains empty name and short_name fields, and references non-existent icon files (/android-chrome-192x192.png and /android-chrome-512x512.png). Please configure these fields with correct values and point the icons to existing assets.
{"name":"Zane Docs","short_name":"Zane","icons":[{"src":"/favicons/zane-colorised.svg","sizes":"any","type":"image/svg+xml"}],"theme_color":"#ffffff","background_color":"#ffffff","display":"standalone"}
| "lucide-astro": "^0.556.0", | ||
| "sass": "^1.98.0", | ||
| "sharp": "^0.34.2", | ||
| "typescript": "^5.9.3" | ||
| }, | ||
| "devDependencies": { | ||
| "sass-embedded": "^1.100.0" | ||
| } |
There was a problem hiding this comment.
The dependencies lucide-astro, sass, and sass-embedded are no longer used in the project since the custom components and Sass styles have been removed in favor of Starlight. They should be removed from package.json to keep the project dependencies clean.
|
|
You have to |
|
I thought i did, but i'll recheck |
2 participants
Summary of changes:
All previous components have been kept but I didn't integrate them in the UI since there was no need.