Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Reorganize the documentation journey #461

Merged
merged 30 commits into from
Sep 13, 2024
Merged

Conversation

admc
Copy link
Member

@admc admc commented Sep 12, 2024

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.

… I think this way of organization makes a lot more sense
Copy link

vercel bot commented Sep 12, 2024

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

@admc admc marked this pull request as draft September 12, 2024 22:12
@sourishkrout
Copy link
Member

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

@admc
Copy link
Member Author

admc commented Sep 13, 2024

@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
Copy link
Member Author

admc commented Sep 13, 2024

@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 🙏

@sourishkrout
Copy link
Member

sourishkrout commented Sep 13, 2024

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

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

@admc
Copy link
Member Author

admc commented Sep 13, 2024

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

Copy link
Member

@sourishkrout sourishkrout left a comment

Choose a reason for hiding this comment

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

✅ LGTM

@sourishkrout sourishkrout merged commit caac57b into main Sep 13, 2024
3 checks passed
@sourishkrout sourishkrout deleted the admc/reorganize-consolidate branch September 13, 2024 18:13
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