feat!: relaunch w/ Astro.js starlight backed documentation#943
feat!: relaunch w/ Astro.js starlight backed documentation#943gildesmarais merged 33 commits intomainfrom
Conversation
632217c to
83051c0
Compare
Signed-off-by: Gil Desmarais <git@desmarais.de>
375b8fb to
c8b0ac9
Compare
There was a problem hiding this comment.
Pull Request Overview
This PR migrates the html2rss.github.io documentation site from Jekyll/Ruby to Astro + Starlight (Node.js/TypeScript). It removes legacy Jekyll, Ruby, and SCSS configuration, updates developer workflows, and introduces comprehensive documentation with new project instructions and standards. The changes streamline the build process, improve developer experience, and establish clear guidelines for future contributions.
- Complete migration from Jekyll to Astro framework with Starlight documentation theme
- Removal of all Jekyll/Ruby-specific files and dependencies, replacing with Node.js toolchain
- Introduction of comprehensive documentation structure with feed directory, tutorials, and reference materials
Reviewed Changes
Copilot reviewed 98 out of 121 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| astro.config.mjs | Main Astro configuration with Starlight setup and extensive meta tags |
| package.json | Updated from Jekyll/Ruby to Astro/Node.js dependencies |
| src/content/docs/ | New MDX-based documentation structure replacing Jekyll markdown |
| src/components/ | New interactive components like FeedDirectory with vanilla JavaScript |
| .github/workflows/ | Updated CI/CD workflows from Jekyll to Astro build process |
Comments suppressed due to low confidence (1)
src/components/FeedDirectory.astro:1
- The default instance URL is base64 encoded, which provides no security benefit and makes the code less readable. Consider using the plain URL directly or explaining why encoding is necessary.
---
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| Authorization: "Bearer {{api_token}}" | ||
| X-User-ID: "{{user_id}}" |
There was a problem hiding this comment.
The dynamic parameter syntax shown here uses {{parameter}} but the actual html2rss gem uses %<parameter>s format as shown elsewhere in the documentation. This inconsistency could confuse users about the correct syntax.
| Authorization: "Bearer {{api_token}}" | |
| X-User-ID: "{{user_id}}" | |
| Authorization: "Bearer %<api_token>s" | |
| X-User-ID: "%<user_id>s" |
This pull request migrates the
html2rss.github.iodocumentation site from a Jekyll/Ruby-based setup to a modern Astro + Starlight (Node.js/TypeScript) stack. It removes legacy Jekyll, Ruby, and SCSS configuration, updates developer workflows, and introduces new project instructions and documentation standards. The changes streamline the build process, improve developer experience, and set clear guidelines for future contributions.Migration to Astro & Node.js (removal of Jekyll/Ruby):
_config.yml, SCSS files, Gemfile, plugins, and legacy HTML templates (404.html, head_custom.html, main.scss, base.scss). [1] [2] [3] [4]R1, [5] [6]gh-pages.yml,lint.yml) to use Node.js and npm for building, linting, and deploying the site, replacing Ruby/Jekyll steps. [1] [2] [3]Developer workflow and tooling updates:
Makefile,.prettierignore, workflow files) and updated commands to match Astro conventions (dev, build, preview, lint). [1] [2] F31f5f67L1).devcontainer/devcontainer.jsonto remove unnecessary VSCode extensions, focusing on those relevant to the new stack.Documentation and project instructions:
.github/copilot-instructions.mdwith clear guidelines for documentation writing, coding standards, accessibility, and performance for the new Astro/Starlight site..cursor/rules/read-copilot-instructions.mdcto enforce following these instructions for all contributors and AI assistants.README.mdto reflect the new stack, developer setup, available commands, and browser-based development via Codespaces. [1] [2]Code style and linting:
These changes lay the foundation for a modern, fast, and maintainable documentation site using Astro and Starlight, with clear standards and improved developer experience.