playbooks

home / skills / railwayapp / railway-skills / railway-docs

railway-docs skill

/plugins/railway/skills/railway-docs

This skill fetches up-to-date Railway docs to accurately answer questions about features, pricing, and usage.

npx playbooks add skill railwayapp/railway-skills --skill railway-docs

Review the files below or copy the command above to add this skill to your agents.

Files (5)
SKILL.md
1.8 KB
---
name: railway-docs
description: This skill should be used when the user asks about Railway features, how Railway works, or shares a docs.railway.com URL. Fetches up-to-date Railway docs to answer accurately.
---

# Railway Docs

Fetch up-to-date Railway documentation to answer questions accurately.

## When to Use

- User asks how something works on Railway (projects, deployments, volumes, etc.)
- User shares a docs.railway.com URL
- User needs current info about Railway features or pricing
- Before answering Railway questions from memory - check the docs first

## LLM-Optimized Sources

Start here for comprehensive, up-to-date info:

| Source             | URL                                         |
| ------------------ | ------------------------------------------- |
| **Full docs**      | `https://docs.railway.com/api/llms-docs.md` |
| **llms.txt index** | `https://railway.com/llms.txt`              |
| **Templates**      | `https://railway.com/llms-templates.md`     |
| **Changelog**      | `https://railway.com/llms-changelog.md`     |
| **Blog**           | `https://blog.railway.com/llms-blog.md`     |

## Fetching Specific Pages

Append `.md` to any docs.railway.com URL:

```
https://docs.railway.com/guides/projects
→ https://docs.railway.com/guides/projects.md
```

## Common Doc Paths

| Topic       | URL                                              |
| ----------- | ------------------------------------------------ |
| Projects    | `https://docs.railway.com/guides/projects.md`    |
| Deployments | `https://docs.railway.com/guides/deployments.md` |
| Volumes     | `https://docs.railway.com/guides/volumes.md`     |
| Variables   | `https://docs.railway.com/guides/variables.md`   |
| CLI         | `https://docs.railway.com/reference/cli-api.md`  |
| Pricing     | `https://docs.railway.com/reference/pricing.md`  |

Overview

This skill fetches up-to-date Railway documentation to answer questions about Railway features, behavior, and pricing. It recognizes docs.railway.com URLs and converts them to markdown endpoints to retrieve the latest content. Use it to ensure answers reflect the current official docs rather than relying on memory.

How this skill works

When invoked, the skill checks for docs.railway.com links or Railway-related queries, then fetches the corresponding .md pages from Railway’s documentation endpoints. It reads targeted pages (projects, deployments, volumes, CLI, pricing, etc.) and summarizes or cites the relevant sections to produce accurate responses. The skill prefers the LLM-optimized sources and the llms.txt index for comprehensive coverage.

When to use it

  • User asks how a Railway feature works (projects, deployments, volumes, variables).
  • User shares a docs.railway.com URL and expects a summary or explanation.
  • You need current pricing, limits, or behavioral details that may have changed.
  • Before answering Railway questions from memory to avoid stale info.
  • When converting a docs URL to a fetchable .md endpoint for precise content.

Best practices

  • Always convert docs.railway.com links to their .md equivalents before fetching.
  • Prioritize the Full docs and llms.txt index listed by Railway for authoritative content.
  • Cite or paraphrase specific doc sections when giving technical instructions.
  • Check changelog or blog pages for recent behavioral or policy changes.
  • If docs are ambiguous, fetch related guide and reference pages rather than guessing.

Example use cases

  • User pastes https://docs.railway.com/guides/volumes and asks how volumes persist data.
  • Explain how Railway handles environment variables and secrets using the variables guide.
  • Compare deployment workflows by fetching deployments.md and summarizing CI/CD steps.
  • Retrieve latest pricing details from reference/pricing.md for cost estimates.
  • Walk a user through the CLI commands by pulling reference/cli-api.md and showing examples.

FAQ

Can this skill fetch any docs.railway.com page?

Yes. Append .md to a docs.railway.com URL and the skill will fetch that markdown page to read current content.

Which pages are best to start with for comprehensive info?

Start with the Full docs (api/llms-docs.md) and the llms.txt index, then check guides like projects.md, deployments.md, and reference pages such as pricing.md.