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

Documentation Fork #10

Open
jpmc opened this issue Jun 18, 2024 · 4 comments
Open

Documentation Fork #10

jpmc opened this issue Jun 18, 2024 · 4 comments
Labels
documentation Improvements or additions to documentation

Comments

@jpmc
Copy link

jpmc commented Jun 18, 2024

I noticed that in your README that you still link https://docs.dropzone.dev/ as the "Full Documentation".

I believe that there should be a fork of the documentation gitbook, a freebie github.io page would be fine, doesn't need a competing domain name.

I suggest this for two main reasons, though there could be more justification to be found:

  1. What if the original Dropzone documentation disappears one day?
  2. What if a bugfix or feature in this fork changes something enough that the documentation is incorrect (parameter name changed, required config option removed or added, etc.)

I would still perhaps link the original docs as well for sure, not sure how to handle that or if it would be too confusing. Some suggestions:

  • "Full documentation" is the new/cloned docs, "Original Documentation" is the existing https://docs.dropzone.dev link.
  • Just "Full documentation" pointing to the new/cloned docs, no old link.
  • "Full Documentation" new, but "Legacy Documentation" for the old.
  • Keep https://docs.dropzone.dev as the "Full Documentation" link and just add your cloned one as "Documentation Mirror"
@NicolasCARPi
Copy link
Owner

Hello James,

You don't need to argue your point. I fully agree. It was not done yet because it was not the priority, but thank you for opening this issue. I'll need to look into adding the doc in this repo.

I'll obliterate any mention of the old documentation.

@NicolasCARPi NicolasCARPi added the documentation Improvements or additions to documentation label Jun 18, 2024
@NicolasCARPi
Copy link
Owner

Unfortunately, it seems the source code for the doc is not public :/ (unless someone can point me to it?)

So for the moment it's best to leave it like that, but that means someone will have to write docs from scratch.

@stephencmorton
Copy link

Has anybody contacted @enyo Matt Simon, the original author, to see if he'd provide the help?

@NicolasCARPi
Copy link
Owner

Just sent this email to him:

2024-11-06-181441_579x288_scrot

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants