nteract / semiotic-docs Goto Github PK

This is minor and annoying to fix but it was a stumbling block for me.

The "Copy Full Code" didn't copy anything and the examples didn't have the complete data in it. Because I didn't realize this worked other browsers, I went digging through the repo to find the data.

I think this is what's not supported in Safari:

Unfortunately, I don't have time right now to make a PR.

I understand if you would want to mark this as wontfix and move on. If you do want to fix it, here are some resources:
https://stackoverflow.com/questions/40147676/javascript-copy-to-clipboard-on-safari
https://github.com/zenorocha/clipboard.js
https://github.com/feross/clipboard-copy

Thanks

I can't find any info on adding legends in the docs. The only ref. I can find is the old wiki docs here: https://github.com/nteract/semiotic/wiki/Legend

I'm assuming (hoping) this feature is still supported? :)

As we move toward semiotic v2, we plan to move all documentation over to the semiotic repo. See discussion nteract/semiotic#572

After migrating into the semiotic repo, this repo will be archived.

I was trying out the repo locally and found that yarn failed to install silently. To fix, I deleted yarn.lock and ran yarn again to generate a new file that removed the internal urls.

Love these docs, BTW!

Before these new docs were made, Semiotic had another set of examples in the library source folder, some of which showcased features of the library which aren't included in the new docs yet.

• The old code can be found here: https://github.com/nteract/semiotic/tree/master/src/docs/components
• To visit the old site:
  • Clone the https://github.com/nteract/semiotic repository
  • run npm install && npm run gh-pages
  • Serve the build folder using a local http server of your choice
  • Alternately, npm start or yarn start can be used to work with a live hot-reloaded version of the site.

This is a non-exhaustive list of examples from the old documentation that I think people could be interested in:

• Shared Tooltip
• Pie/Donut
• Chord Diagram
• Information Model (Transform bar to parallel coordinates) (#18)
• Legend (See #7 )
• Faceting
• Violinplot
• ... multiple others! Please edit this issue as you notice additional items.

Loving the new docs!

When copying the source code to try an example in CodePen I can click the 'Copy Full Code' button to copy the source code but not the CSS.

Would it be possible to be able to copy the styles too for each example? This would be really useful.

Semiotic docs have some nice examples of what you can do when applying basic settings to the available frame types.

But I think there would be real value in adding a page to the docs site with a curated list of user-submitted examples to show off what this data visualization framework is really capable of.

There are many ways user submissions could work but how about having examples shown on the docs site as a thumbnail gallery which links to a live CodePen example, so the code itself can be explored and experimented with.

Obviously, not everyone who has created a data viz will have used CodePen so the ones that aren't would need to be recreated as a pen. The ones that are done as a pen could be forked into an official Semiotic CodePen account and cleaned up and the thumbnail redone if necessary. The thumbnail could then be displayed in the gallery on the Semiotics docs.

It should be possible to auto-create an image gallery pens from an RSS feed. e.g. https://codepen.io/emeeks/public/feed

Each CodePen collection also has it's own feed so we could split all submissions roughly into each data viz type and still auto-generate the gallery, which would cut down on the admin work.

The thumbnail can be generated as long as you know the pen URL (which is in the RSS feed): https://blog.codepen.io/documentation/api/screenshots/

To help generate interest, a prominent link on the docs site to prompt users to submit work could work well?

I'd be happy to help out with any of this. Unless there was a lot of submissions it shouldn't be too much work to create forks of pens and cleaning them up if necessary.

The doc seems to be formatted incorrectly with some truncated code.

The following error pops up in the console and the screen blanks out when navigating to this page using the build from the current master branch - I am guessing that this example might not be compatible with the current version (1.20.2) of Semiotic in some way.

• localhost:3000/examples/waterfall-chart
• Code: https://github.com/nteract/semiotic-docs/blob/master/src/examples/WaterfallChart.js