alloy-editor icon indicating copy to clipboard operation
alloy-editor copied to clipboard

Why Doesn't Your Documentation *Link* to The Example React Code

Open machineghost opened this issue 4 years ago • 0 comments

Do you want to request a feature or report a bug? Documentation failure

What is the current behavior? The documentation just says "go find the example, we promise it exists somewhere in GitHub"

If the current behavior is a bug, please provide the steps to reproduce and if possible a minimal demo of the problem. Go to https://alloyeditor.com/docs/use/react_component.html

What is the expected behavior?

The web has had hyperlinks since before the turn of the century. A single <a href="URL of example in GitHub"/> would be a heck of a lot friendlier to someone considering your library ... and I truly don't think it's too much to ask to expect a link from the documentation a web development library ... especially when it's already being unfriendly by not just showing a code example in the documentation (like every other library in existence).

Which versions of alloy-editor, and which browser / OS are affected by this issue? Did this work in previous versions?

machineghost avatar Sep 07 '20 02:09 machineghost