notion-to-md icon indicating copy to clipboard operation
notion-to-md copied to clipboard

Outdated Documentation: The "Getting started" documentation is depreciated

Open Travcort opened this issue 6 months ago • 2 comments

Hello, I noted that the code snippet in the official documentation here appears to be outdated which is a bit confusing for first time users. I however noted that the README in the main repository here correctly specifies the implementation.

I was hoping you would kindly update it for easier future use I'd be happy to help contribute a fix if needed. Thanks for all your work on this project! It has been fun to use!

Travcort avatar May 20 '25 13:05 Travcort

Hey @Travcort, the getting started docs you linked to is for v4 (which introduces a lot of new concepts), which is in alpha stage. The 2nd link you pointed to, i.e README is for v3 which is stable.

I understand the docs are a bit here and there and not easy to understand I'm still figuring out how to make it more user-friendly. If you have any input/suggestions on better way to structure the docs, it'll help a lot.

souvikinator avatar Jun 16 '25 13:06 souvikinator

How about you still include the docs for v3 which is still stable in the official documentation for those who might use it? An example is someone like me who ended up using v3.1.9 instead of v4 because I used the README guide in the official repository. I think supporting docs for the v3 is still important before v4 becomes stable. Thank you.

Travcort avatar Jun 18 '25 16:06 Travcort