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

Please link to old docs? #102

Closed
rashkov opened this issue Nov 10, 2020 · 11 comments
Closed

Please link to old docs? #102

rashkov opened this issue Nov 10, 2020 · 11 comments

Comments

@rashkov
Copy link

rashkov commented Nov 10, 2020

Could we please link to the old docs at https://bucklescript.netlify.app/ ? As a kindness for people who are still on versions of Bucklescript older than 8.0.0. The company where I work is doing our best to migrate to 8.0.0 but we're not there yet. No one on my team knew how to find the old docs, and the only reason I knew is because I asked on the Discord channel. It shouldn't be that hidden. Please, for the sake of long time bucklescript users, can we support the old docs a little?

@jfrolich
Copy link

I am interested why you are still < 8.0. There have been very few breaking changes.

@ryyppy
Copy link
Member

ryyppy commented Nov 11, 2020

this sounds like you are actually on BS v5. What prevents you from upgrading?

@rashkov
Copy link
Author

rashkov commented Nov 11, 2020

withstyles ppx from an old version of bs-material-ui

edit: At any rate, it feels wrong to delete docs for code that was released only about a year ago (5.2.1 was October 2019). As a matter of principle, old docs should always be preserved unless they're inaccurate.

There's also clearly a demand given that someone took the time to re-deploy them. There's good work that went into writing those docs, and they're still useful to some number of people who have gotten stuck with old PPX'es or need to engage with a legacy code base in order to bring it up to date.

I think there's something admirable about a dedication to supporting old versions, like this:
https://material-ui.com/versions/
https://getbootstrap.com/docs/versions/

What's the big concern here? Poor SEO? Lack of resources? I don't want to create extra work here, so I'd be happy to submit a pull request, but it's not clear to me that this work would be considered for inclusion.

@ryyppy
Copy link
Member

ryyppy commented Nov 13, 2020

The v8 docs are pretty much just the v7 docs, the v7 docs are what you see on the unofficial bucklescript netlify deployment you posted above.

What kind of information are you missing on the v8.0.0 docs in particular? bs.deriving?

@rashkov
Copy link
Author

rashkov commented Nov 13, 2020

Appreciate the response... I didn't realize that's the only difference between v8.0.0 docs and older. Yes, bs.deriving was missing and that made me completely doubt the completeness of the docs. If that's really the only difference then this issue is much smaller than I realized, and I feel a lot better about the docs situation.

I do think bs.deriving warrants inclusion, and I still think it's very jarring to see that anything older than v8.0.0 is unacknowledged and unavailable, like it never existed. The fact that v8 docs can be used for v7 is good to know, but not at all obvious without having closely followed the releases, and it was easy for me to think that there was a lot more than that which was lost during the bump to v8 and the rebrand to rescript.

@schutm
Copy link

schutm commented Nov 13, 2020

I'm missing the ocaml syntax... I understand you're moving away from the ocaml syntax. However sticking on an older version (pre 8.2) would not be sensible if the documentation is taken away (and yes, I'm using/taking advantage of both compiling with bucklescript and the ocaml compiler itself).

However removing the documentation completely, makes me wonder whether sticking with rescript/reason/bucklescript is a viable option for the future.

[fixed some typos]

@chenglou
Copy link
Collaborator

@rashkov your concern is legit but as Patrick said, most of the content is still there. We'll make this a bit less scary by changing the dropdown option of 8.0.0 to < 8.2.0

bs.deriving can be added back. Would you mind providing a rough list of things you found missing? (Use the search to check if it's there)

@yawaramin
Copy link
Contributor

Maybe this is already on the radar but thought I'd mention, the Node API docs are unavailable.

@jsiebern
Copy link

@rashkov Sorry you're having update troubles with the ppx. Feel free to contact me on discord (Jonathan#2836) or DM me on twitter (@j_siebern) and I'll be happy to help you upgrade to the latest version.

@ryyppy
Copy link
Member

ryyppy commented Nov 17, 2020

I changed the way versions are being displayed on the docs (see #112) to make it more clear that the < 8.2.0 are supposed to cover the original BuckleScript website in its fullest.

Since there are some features missing, please let us know in #113 what kind of information you are relying on.

@rashkov
Copy link
Author

rashkov commented Nov 19, 2020

Thanks everyone!

@rashkov rashkov closed this as completed Nov 19, 2020
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

No branches or pull requests

7 participants