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

docs: Update home page and server/client index pages to highlight the most important information #203

Open
5 tasks
afolson opened this issue Apr 12, 2024 · 0 comments
Assignees
Labels
community Community enablement feature/issue documentation Improvements or additions to documentation housekeeping Issues that are handled internally by the Nstream team

Comments

@afolson
Copy link
Contributor

afolson commented Apr 12, 2024

Depends on #196 getting merged.

The home page is more marketing-focused and should be more focused on documentation now that we have more of it. Create paths for people to follow depending on what they're trying to do:

  • Introduction to explain SwimOS at a high level
  • CTA to get started for free in several locations
  • Developers should be driven towards Rust/Java dev guides and tutorials but also made aware that reference docs exist.
  • Developers trying to build front ends for apps should go to Typescript docs
  • Users just looking for more info should be able to find demos and concept docs

@will347 Would love your thoughts on this. I'm thinking we show those three options and then scroll down to some anchor with a list of relevant documentation. This would keep the happy path choices above the fold and keeps that content skimmable for folks who don't know what they want yet. I'm totally open to ideas though!

@afolson afolson added documentation Improvements or additions to documentation community Community enablement feature/issue housekeeping Issues that are handled internally by the Nstream team labels Apr 12, 2024
@afolson afolson self-assigned this Apr 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
community Community enablement feature/issue documentation Improvements or additions to documentation housekeeping Issues that are handled internally by the Nstream team
Projects
None yet
Development

No branches or pull requests

1 participant