Skip to content

Remove outdated content #719

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

Merged
merged 28 commits into from
Jan 7, 2021
Merged

Conversation

ryyppy
Copy link
Contributor

@ryyppy ryyppy commented Jan 2, 2021

Motivation

The Reason community and ReScript forum gets flooded with questions regarding Reason / ReScript, and many of those are caused by outdated content in the ReasonML documentation website.

This PR is an attempt to clear the docs from any outdated references of BuckleScript / ReScript (at least where it makes sense). I also took the chance and removed a lot of stale content that doesn't make any sense in the current mission of ReasonML (the one where Reason tries to be 100% OCaml compliant, with a primary native compilation story, powered by esy, dune, OCaml and JSOO).

Change Summary

  • Updated landing page (copy changes, removed stale examples and quickstart)
  • Updated install instructions (native workflows, quick mention of prev. BuckleScript setups with link to ReScript website)
  • Updated the editor-setup page to focus more on the up-to-date plugins like vscode-ocaml-platform and ocaml-lsp
  • Removed the "Native" section in the sidebar and first-classed it in the installation / editor-setup pages
  • Removed "Reason Association" and "Hemnet" from the users-of-reason page
  • Removes community-roadmap... the roadmap narrative is 4 years old and doesn't reflect the current state of Reason
  • Updates the events page (removed many dead links and groups that don't exist anymore)
  • Removed the community-examples page, since these sport the same outdated examples like the landing page
  • Updated the extra-goodies -> Removed bsb-native mention (this project is also really old and unrelated to the current Reason narrative)

I'd appreciate a review rather soon. The website has been in this mixed state for more than 6 months now, and it's kinda misleading for newcomers.

\cc @cristianoc

ryyppy added 18 commits January 2, 2021 16:24
The Reason Association is using ReScript, and Hemnet needs to be taken
down for legal / copyright reasons (wanted to aid @believer in getting this
change upstream)
- Update marketing blocks
- Remove ReScript related quick start
- Remove unrelated examples section (these are all outdated ReScript projects)
Remove outdated and wrong installation instructions
and add an esy / hello-reason quickstart example.
These two pages were almost exclusively targeted to old BuckleScript
conventions, that aren't even up to date. Removing this info will help
not mixing up BuckleScript'isms with native development.
Like the landing page, the examples are terribly outdated and don't
reflect modern Reason at all.
This page is terribly outdated as well
Copy link
Contributor

@kyldvs kyldvs left a comment

Choose a reason for hiding this comment

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

Thanks for working on this, definitely a big improvement from the mixed state we were in!

I left a few comments for things easy to fix, and I think there are some things we can refine later, but I don't mind getting this in first and coming back to refine since the docs are in such a confusing place already :)

The one area that I do want to fix up first is in the FAQ, and the explanations around Reason vs ReScript. @jordwalke can take a look there, for now it might be easiest to simply link to the other articles rather than re-hashing the explanations in the FAQ. If you think it's important to have that in the FAQ with that much detail we can give more concrete feedback though

ryyppy added 8 commits January 3, 2021 09:30
- Added note on ReScript JSX docs for ReasonReact usage
- Removed ReasonReact / BuckleScript mentions
- Added ReveryUI as a framework using the JSX semantics
Some companies seem to be gone, and I couldn't find
any sign of being renamed / being acquired, so I removed
them.
@ryyppy
Copy link
Contributor Author

ryyppy commented Jan 3, 2021

Just realized that the JSX, Object, and External docs still had some BuckleScript related content. Refactored that by putting in Reason / OCaml native equivalents.

@ryyppy
Copy link
Contributor Author

ryyppy commented Jan 5, 2021

Okay, I think now it's ready for a last quick read.. FAQ part was reduced to a minimum + link to the ReScript blog post.

@kyldvs
Copy link
Contributor

kyldvs commented Jan 6, 2021

Thanks, I'll give this a final pass tomorrow and see if I spot anything else before merging.

@kyldvs kyldvs merged commit 18dc62a into reasonml:source Jan 7, 2021
@kyldvs
Copy link
Contributor

kyldvs commented Jan 7, 2021

Thank you @ryyppy for working on this!

@ryyppy
Copy link
Contributor Author

ryyppy commented Jan 7, 2021

Thanks Kyle!

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.

2 participants