a month ago
This quarter we plan on improving Railway's Documentation
What's been hard to find? What guides didn't click? What feature did you have to figure out on your own because the docs weren't there?
Whether it's a missing page, a confusing explanation, or just a small nit — Let me know in this thread and I'll personally fix it 🫡
0 Threads mention this feature
3 Replies
a month ago
git style watch paths are supported, and to me tie closely to "github integration"/deployment triggers. Yet are not mentioned in https://docs.railway.com/guides/github-autodeploys#configure-the-github-branch-for-deployment-triggers
AND in the service settings, are listed far below the Source section, which I feel is confusing as I feel the "triggers" on changes to "source" but maybe thats just me.
a month ago
1) More context and explanation in the GQL docs.
2) More in-depth explanation of deployments and the "railway" way of thinking about them and how they may differ from more conventional ways of thinking about "spinning up a service" in AWS (for example)
a month ago
The first time I looked at the CLI Guides was by clicking the Visit the CLI Docs link in the screenshot below. I thought that it was the only documentation for the CLI. A few months passed and by accident I discovered the CLI API Reference docs - has docs for every single command unlike the guides. This might've happen for others as well, were they didn't know the reference page exists. So I recommend improving the UX on the guides and reference pages with interlinking eg. each guide page has a link to the respective references and each reference page has a link to the respective guide.
Attachments