Skip to content

feat!: relaunch w/ Astro.js starlight backed documentation#943

Merged
gildesmarais merged 33 commits intomainfrom
feat/astro-starlight-rewrite
Sep 17, 2025
Merged

feat!: relaunch w/ Astro.js starlight backed documentation#943
gildesmarais merged 33 commits intomainfrom
feat/astro-starlight-rewrite

Conversation

@gildesmarais
Copy link
Copy Markdown
Member

@gildesmarais gildesmarais commented Sep 14, 2025

This pull request migrates the html2rss.github.io documentation 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):

  • Removed Jekyll-specific files and configuration including _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]
  • Updated workflow files (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:

  • Replaced Yarn with npm throughout the project (Makefile, .prettierignore, workflow files) and updated commands to match Astro conventions (dev, build, preview, lint). [1] [2] F31f5f67L1)
  • Updated .devcontainer/devcontainer.json to remove unnecessary VSCode extensions, focusing on those relevant to the new stack.

Documentation and project instructions:

  • Added .github/copilot-instructions.md with clear guidelines for documentation writing, coding standards, accessibility, and performance for the new Astro/Starlight site.
  • Added .cursor/rules/read-copilot-instructions.mdc to enforce following these instructions for all contributors and AI assistants.
  • Updated README.md to reflect the new stack, developer setup, available commands, and browser-based development via Codespaces. [1] [2]

Code style and linting:

  • Removed legacy configuration files for Prettier and Stylelint to match the new stack and simplify code formatting standards. [1] [2]

These changes lay the foundation for a modern, fast, and maintainable documentation site using Astro and Starlight, with clear standards and improved developer experience.

@gildesmarais gildesmarais force-pushed the feat/astro-starlight-rewrite branch from 632217c to 83051c0 Compare September 17, 2025 07:22
@gildesmarais gildesmarais force-pushed the feat/astro-starlight-rewrite branch from 375b8fb to c8b0ac9 Compare September 17, 2025 15:16
@gildesmarais gildesmarais changed the title feat: goodbye jekyll, hello astro feat!: relaunch w/ Astro.js starlight backed documentation Sep 17, 2025
Copy link
Copy Markdown
Contributor

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

Comment thread src/content/docs/ruby-gem/reference/selectors.mdx
Comment on lines +88 to +89
Authorization: "Bearer {{api_token}}"
X-User-ID: "{{user_id}}"
Copy link

Copilot AI Sep 17, 2025

Choose a reason for hiding this comment

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

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.

Suggested change
Authorization: "Bearer {{api_token}}"
X-User-ID: "{{user_id}}"
Authorization: "Bearer %<api_token>s"
X-User-ID: "%<user_id>s"

Copilot uses AI. Check for mistakes.
Comment thread src/content/docs/troubleshooting/troubleshooting.mdx
Comment thread src/content/docs/web-application/reference/env-variables.mdx
@gildesmarais gildesmarais merged commit c3a8285 into main Sep 17, 2025
4 checks passed
@gildesmarais gildesmarais deleted the feat/astro-starlight-rewrite branch September 17, 2025 15:27
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.

2 participants