Skip to content
This repository has been archived by the owner on Aug 31, 2023. It is now read-only.

☂️ Website for release #496

Closed
14 tasks done
sebmck opened this issue May 21, 2020 · 13 comments
Closed
14 tasks done

☂️ Website for release #496

sebmck opened this issue May 21, 2020 · 13 comments
Labels
A-Website Area: website and documentation umbrella Issue to track a collection of other issues

Comments

@sebmck
Copy link
Contributor

sebmck commented May 21, 2020

This issue lists improvements that need to be done to the existing website before we release:

  • Fix dark logo not being used on page load. (You need to flip the toggle twice to correct it) Fixed by @EduardoLopes in Bump docusaurus version #497
  • Remove star count from homepage Fixed by @sreetamdas in chore: update website for release #498
  • Update tagline "Rome is an experimental JavaScript toolchain" to "Rome is a JavaScript toolchain" Fixed by @sreetamdas in chore: update website for release #498
  • Update tagline "A compiler, linter, formatter, bundler, testing framework and more" to "Linting, bundling, compiling, testing, and more" Fixed by @sreetamdas in chore: update website for release #498
  • Remove experimental warning banner Fixed by @sreetamdas in chore: update website for release #498
  • Remove Facebook open source footer and banner
  • Remove the selling point feature titles
  • Move all separate documentation pages into the homepage
  • Extend homepage documentation to completely cover installation, what Rome supports, project setup, linting, and editor integration
  • Dark mode
  • Drop tocbot and add a custom script that generates the TOC
  • Fix conflict of heading with the same id (Getting started and Contributing - > Getting Start)
  • Add footer or a section with links for twitter, discord server, open collective and etc
  • Support for screen-readers

I think we should invoke the clean and simple vibe from successful open source projects of old. Notably CoffeeScript, Undercore, and Backbone (Basically any Jeremy Ashkenas project).

We should have a single page website that covers 90% of the documentation someone needs. It can be long. It should load fast. We should have a table of contents on the side to allow for quick jumping with excessive anchors to allow deep linking. It should be readable and understandable from someone reading top to bottom. We can have dedicated subpages for niche or advanced topics.

We don't need to prove ourselves to anyone. We don't need flashy bullet points or a comparison with existing tools right in your face when you go to the landing page. The website should be aimed at serving the users rather than serving as something flashy for adoption. Much less startupy.

It would be nice for us to migrate away from something complicated like Docusaurus that we use to something like Eleventy that better serves the fast single-page content focused website that we want.

@sebmck sebmck added the umbrella Issue to track a collection of other issues label May 21, 2020
@sebmck sebmck changed the title ☂️ Release website ☂️ Website for release May 21, 2020
@sebmck sebmck pinned this issue May 21, 2020
@EduardoLopes
Copy link
Contributor

Once i wake up, i'll take care of the tasks that can already be applied to the current website. Then, i'll check out Eleventy!

@sreetamdas
Copy link
Contributor

@sebmck shouldn't the README also be updated to remove the experimental warning and other things to keep in sync with the website?

@sebmck
Copy link
Contributor Author

sebmck commented May 21, 2020

@sreetamdas Yeah it should.

@EduardoLopes
Copy link
Contributor

EduardoLopes commented May 22, 2020

Just pushed a branch for the new website: EduardoLopes/new-website

It setup eleventy with CSS and JS minification, syntax highlighting and automatic table of content using Tocbot.

I've added purecss as well, i think it's cool because we don't need to write much css to deal with responsive grids and stuff. And we can use only the parts we need (the base and grids). If it's overkill anyways, it's ok to remove it!

There's no design at all, i was just making things run! I care a lot about the design of the site, since i made the logo. I didn't make a doc to describe visual identity, so if you're working on the website, make sure to follow the design of the old website. I can tweak latter, if i feel like.

instructions on the README.md!

@EduardoLopes
Copy link
Contributor

Thanks to @matvp91 we got a lot done already.

I've add some more tasks and created a pull request for review #507

@MareikeTaeubner
Copy link

What points are still in need for documentation? I kind of lost the overview ^^"

@matvp91
Copy link
Contributor

matvp91 commented May 22, 2020

@MareikeTaeubner sorry, we're mixing both the "old" Docusaurus site and the "new" Eleventy site.

Let's clean this up :)

@lishine
Copy link

lishine commented Jun 17, 2020

Your website is down

@sebmck
Copy link
Contributor Author

sebmck commented Jun 17, 2020

It’s intentional. The site is at https://preview.romejs.dev/. Having the old site up was confusing because it was outdated.

@KidyasoVasiliy
Copy link

@sebmck please, change description on repo
now is https://romejs.dev address is indicated there

thanks

@sebmck
Copy link
Contributor Author

sebmck commented Jul 8, 2020

New website issues that are unowned/unassigned if anyone is interested:

@sebmck sebmck added the A-Website Area: website and documentation label Jul 8, 2020
@sebmck sebmck added this to the Release launch milestone Jul 14, 2020
@ematipico
Copy link
Contributor

@sebmck I think we can close this one, the website is finally live :)

@sebmck sebmck closed this as completed Aug 9, 2020
@sebmck
Copy link
Contributor Author

sebmck commented Aug 9, 2020

🎉

@ematipico ematipico unpinned this issue Aug 10, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
A-Website Area: website and documentation umbrella Issue to track a collection of other issues
Projects
None yet
Development

No branches or pull requests

8 participants