☂️ Website improvements - Githubissues

rome / tools

Unified developer tools for JavaScript, TypeScript, and the web

https://docs.rome.tools/

MIT License

23.72k stars 659 forks source link

☂️ Website improvements #3447

Closed MichaReiser closed 1 year ago

MichaReiser commented 2 years ago

Description

This is an umbrella issue to collect improvements to our current website. This covers changes to the content as well as fixing broken functionality.

Must

[x] Rewrite Getting Started section #3547

Improvements

[ ] Go through linter/formatter documentation
[x] Extend editor section (I like the AstroBuild Editor Setup page)
[ ] Document ignoring files
[ ] Document JSX suppression comments
[ ] Migration Guide @sebmck
[ ] System requirements: Mention glibc requirements?
[x] CLI redirects #3550
[x] Add package manager tabs @sebmck

Nice to have

[ ] Troubleshooting section
[ ] Document Helix editor

ematipico commented 2 years ago

I think we should expand the "Architecture" chapter, and maybe explain how the VSCode extension work with this new architecture (since it's a client)
remove the "Careers" page (or fix the redirect)
in https://rome.tools/#installation-on-any-other-ci, I think we should remove the table for the downloads. Since we have "latest" tag, sometimes the "latest" can contain the VSCode artifacts (if you try now, it goes to a 404 page)
update the "Post Installation" section. Maybe add a redirect to the rome init command