a-b-street / docs

Technical and user documentation for A/B Street
Apache License 2.0
12 stars 7 forks source link

Redesign front page and user-facing website #25

Closed dabreegster closed 2 years ago

dabreegster commented 2 years ago

Currently abstreet.org lands people on the Github page, which

1) scares off some people, because if they scroll up, they see code 2) is horribly outdated with ancient GIFs and calls everything a "game"

I think https://a-b-street.github.io/docs/ is somewhat reasonably organized for the technical section, and that's about it... user-facing site/docs are tough. Main things a good website should probably do are communicating what we do, why, and how to get involved.

@natesheehan, any thoughts? Or any favorite websites that do a good job of introducing projects that we could model after?

Front page ideas

I imagine the first screenfull of stuff should include:

There are a bunch of different ways of breaking down what we do, and I'm not sure which ones belong.

We could also focus on comparing ourselves to related software. If I had to summarize, our niche is rapid prototyping, aiming at a general audience, and being FOSS.

Another way to phrase things, related to use cases, is by problems:

https://a-b-street.github.io/docs/project/presentations.html have introduced the project in many of these different ways. I'm not sure what'd be best for a website. The SUMO talk is probably one of the better project overviews.

dabreegster commented 2 years ago

28 got this started

natesheehan commented 2 years ago

Apologies, to not give feedback any sooner! But great job on synthesizing this down Dustin, lots to shout about! I think the general structure you've outlined is sweet, wearing a PM hat II would lean- to breaking down A B Street by "software", with features and use cases being a part of each software.

One biggish question I will ask, although I think you have already pondered about, (ref https://github.com/a-b-street/abstreet/pull/788) do you want this to be a vanilla js site? I think the mapbox example works as an awesome vanilla JS demo (similar to how mapbox do their tutorials (e.g https://docs.mapbox.com/mapbox-gl-js/example/mapbox-gl-geocoder-limit-region/). There are a lot of fancy JS frameworks these days, which IMO aren't always as good as they are hyped and take time to master, but they can make help rapid prototyping and other web nuances, with the trade-off (or not) that the website will look like most over websites on the web 🤷

Going forward, we may have to, unfortunately, think about SEO (organic), this would entail a lot of content on the website and might benefit from having some type of markdown generation (I think netlify make this pretty simple)

Websites I like: https://deck.gl/ (and co) feels like a good starting point from a developer perspective https://hydrogen.shopify.dev/ is very fun and informative https://www.mapbox.com/ mapbox homepage is fanchy https://www.common-wealth.co.uk/ Im also a sucker for a minimal design

Happy to assist with any web dev, css and infrastructure tasks!

dabreegster commented 2 years ago

So actually, @trangeriale has just prototyped a design for the front page! Feel free to comment in Figma: https://www.figma.com/file/RX2nOdY2uPaqGGvWPyDvV6/%5BA%2FB-Street%5D-Design-Library?node-id=3547%3A1831

do you want this to be a vanilla js site?

Very good question. I've been imagining this as just a single splash page, so pulling in any framework might be overkill. The rest of the "site" is docs.abstreet.org, generated with mdbook -- which has some notable clunkiness. I would personally be fine with adopting a framework, since it'd let the non-mdbook part of the site grow more readily. Suggestions for which framework very welcome.

https://www.common-wealth.co.uk/ Im also a sucker for a minimal design

I like this one! I was a bit surprised by the cursor effect; haven't seen that kind of early 2000's JS nostalgia in a while.

natesheehan commented 2 years ago

Loving the design @trangeriale, I will leave further comments on the design for that channel.

Suggestions for which framework very welcome.

Meh, to be honest, I agree that if the website is a single splash screen there is little need for any framework. Also, anything I suggest is clouded in the bias of my own usage (node and react). As an aside tho, Mapbox are realsing more demos for using their services with React (https://docs.mapbox.com/help/tutorials/use-mapbox-gl-js-with-react/ or https://github.com/alex3165/react-mapbox-gl)

haven't seen that kind of early 2000's JS nostalgia in a while.

Haha, retro web design is certainly making a resurgence!

dabreegster commented 2 years ago

35 gets this going again, will file followup issues for specific things