docs.runme.dev icon indicating copy to clipboard operation
docs.runme.dev copied to clipboard

Published 20 hours ago • verified publisher icon stateful

Reorganize the documentation journey

Open admc opened this issue 1 year ago • 4 comments

We had duplicated info in a number of places, it was hard to know the difference between a guide and an integration.

I've consolidated into this flow:

  • Understand at a high level what runme is and why it exists
  • Quickly find the thing you want to install
  • Use the thing you installed
  • Configure and expand
  • All the peripheral info people might look for.

Guides become tutorials, which I have removed a bunch of unnecessary introduction, these need more work to make it clear why using them with runme adds value, like with Dagger.

admc avatar Sep 12 '24 21:09 admc

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs-runme-dev ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 13, 2024 6:00pm

vercel[bot] avatar Sep 12 '24 21:09 vercel[bot]

@admc are you on the latest version? Why do we have conflicts?

sourishkrout avatar Sep 13 '24 00:09 sourishkrout

@sourishkrout Not sure what the deal was there, but I merged main, prob had to do with switching computers and pulling the branch without getting main first. But I think all the things are there and all links are fixed now.

admc avatar Sep 13 '24 01:09 admc

@sourishkrout okay, woke up with a bunch more changes in mind, I think I'm at a stopping point now if you wanna take a look 🙏

admc avatar Sep 13 '24 17:09 admc

What I'm noticing, unclear if they are showstoppers or not:

  • [x] Cutover will break links. We should make sure we have redirects in place.

sourishkrout avatar Sep 13 '24 17:09 sourishkrout

Just checked in an updated vercel.json based on sitemap diff.

admc avatar Sep 13 '24 17:09 admc