add-docs-site

Scaffold an Astro Starlight documentation site into a Rails application.

Updated Aug 27, 2026
One-click install
npx skills add https://github.com/Grupo-AFAL/claude-plugins --skill add-docs-site
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: add-docs-site
Source: https://github.com/Grupo-AFAL/claude-plugins/tree/main/docs-tools/skills/add-docs-site
Command: npx skills add https://github.com/Grupo-AFAL/claude-plugins --skill add-docs-site

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Provides a repeatable, production-ready scaffold to add a static Astro Starlight documentation site inside a Rails application so teams can publish end-user documentation without changing Rails routing or infrastructure.

Core Features & Use Cases

  • Scaffold and configuration: Creates a docs/ package with astro.config.mjs, package.json, tsconfig, content config, and brandable styles.
  • Zero Rails config changes: Builds static HTML to public/docs so Thruster/ActionDispatch serves docs with no routing changes.
  • Build, Docker, and CI integration: Adds bun-managed installs, Docker build steps, Procfile.dev entry for the dev server, and a GitHub Actions workflow; includes astro-mermaid for diagrams and guidance to commit bun.lock.
  • Content-first Spanish docs: Opinionated sidebar and content structure prioritizing end-user task guides with a collapsible technical reference.

Quick Start

Scaffold an Astro Starlight documentation site inside the Rails app, install bun dependencies, verify the build outputs to public/docs, and add the Docker and CI steps.

Frequently Asked Questions about add-docs-site

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I add a static documentation site to a Rails application?

You can add a static documentation site to a Rails application by scaffolding an Astro Starlight site that builds directly into the public/docs directory, allowing Thruster or ActionDispatch to serve it without altering Rails routing.

Can I use Astro Starlight with a Rails Docker build process?

Yes, Astro Starlight integrates with a Rails Docker build process by adding specific build steps for the documentation site alongside bun-managed dependency installation, ensuring the static HTML is generated during the Docker image creation.

What is the best way to include Mermaid diagrams in Astro Starlight docs?

The best way to include Mermaid diagrams in Astro Starlight docs is to use the astro-mermaid integration, which is automatically configured during the scaffolding process to render diagrams within your documentation content.

Do I need to change Rails routes to serve Astro documentation?

No, you do not need to change Rails routes to serve Astro documentation because the build outputs static HTML to public/docs, allowing existing Rails static file serving mechanisms to handle requests directly.

How does the Astro Starlight dev server work with Rails Procfile.dev?

The Astro Starlight dev server works with Rails Procfile.dev by adding a dedicated entry that runs the local development server, enabling live previews of documentation changes alongside your Rails application.

How to automate publishing Astro Starlight documentation with GitHub Actions?

You can automate publishing Astro Starlight documentation by using a generated GitHub Actions CI workflow that builds the static site and deploys the output, triggered automatically by repository commits.