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

feat: cleaned up /install landing #1936

Merged
merged 6 commits into from
Oct 10, 2024
Merged

feat: cleaned up /install landing #1936

merged 6 commits into from
Oct 10, 2024

Conversation

lidel
Copy link
Member

@lidel lidel commented Oct 3, 2024

Wanted to add missing-but-important "Mainnet" projects (Boxo, Rainbow, Someguy) to /install page, but realized the information architecture was pretty outdated and not very intuitive, so I've separated it into three sections:

  1. User-Friendly Options
  2. Command-Line & Infrastructure Tools
  3. Software Development

This should make it easier for user visiting https://docs.ipfs.tech/install to make choice what to read, and what to skip + help ecosystem with people using Kubo for everything because they don't know better alternatives.

Updated various navigation and content links and applied minor fixes along the way.

cc @mishmosh @2color

Wanted to add Rainbow and Someguy to /install page, but realized the
page was not very intuitive, so I've separated it into three sections:

1. User-Friendly Options
2. Command-Line & Infrastructure Tools
3. Software Development

Updated some links and applied minor fixes along the way.
@lidel lidel changed the title feat: revamped /install landing feat: cleaned up /install landing Oct 3, 2024
Copy link
Collaborator

@mishmosh mishmosh left a comment

Choose a reason for hiding this comment

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

Nice! A few minor suggestions but 2 things to discuss:

  • I don't think this entire page should be labelled as Mainnet. Many of these tools including kubo are used in private networks as well, and Mainnet is still a lesser-known term.
  • Could Kubo move to software development (closer to helia, etc.) which would also that Infrastructure Tools?

Also, why is Helia, Boxo, etc. considered an SDK but Kubo is not?

docs/install/README.md Outdated Show resolved Hide resolved
docs/install/README.md Outdated Show resolved Hide resolved
docs/install/README.md Outdated Show resolved Hide resolved
docs/concepts/ipfs-implementations.md Outdated Show resolved Hide resolved
Copy link
Member

@2color 2color left a comment

Choose a reason for hiding this comment

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

LGTM

Co-authored-by: Daniel Norman <1992255+2color@users.noreply.github.com>
@lidel
Copy link
Member Author

lidel commented Oct 10, 2024

Applied feedback, merging as its already way better than old version which had outdated info.

@lidel lidel merged commit ec9be8e into main Oct 10, 2024
5 checks passed
@lidel lidel deleted the feat-install-revamp branch October 10, 2024 17:28
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.

3 participants