Giter VIP home page Giter VIP logo

semiotic-docs's Introduction

nteract animated logo

the interactive computing suite for you

code coverage maintained with lerna github action ci nteract docs

nteract is an open-source organization committed to creating fantastic interactive computing experiences that allow people to collaborate with ease.

We build SDKs, applications, and libraries that help you and your team make the most of interactive (particularly Jupyter) notebooks and REPLs.

To learn more about the nteract open source organization and the rest of our projects, please visit our website.

What's in this repo?

This repo is a monorepo. It contains the code for the nteract core SDK and nteract's desktop and web applications. It also contains the documentation for the SDK and the applications. Here's a quick guide to the contents of the monorepo.

Folder Description
applications/desktop Source code for the nteract desktop application. The desktop application is a cross-platform app built using Electron.
applications/jupyter-extension Source code the nteract Jupyter extension. This extension can be installed alongside Jupyter classic and JupyterLab in your Jupyter deployments or personal Jupyter server.
packages JavaScript packages that are part of the nteract core SDK.
changelogs Changelogs for each release of the nteract core SDK and applications.

How do I contribute to this repo?

If you are interested in contributing to nteract, please read the contribution guidelines for information on how to set up your nteract repo for development, how to write tests and validate changes, how to update documentation, and how to submit your code changes for review on GitHub.

How do I use the nteract core SDK?

If you are a developer who wants to build an nteract-based notebook application, check out the following documentation resources for more info.

Link What's in it?
docs.nteract.io This page contains our how-to and tutorial style documentation. Get started learning about the nteract core SDK here.
packages.nteract.io This page contains the API documentation for packages in our core SDK. Bookmark this and use it as a reference when building your nteract-based UI.
components.nteract.io This page contains the documentation for our suite of composable React components. It contains code samples that you can reference when building your nteract-based UI.

Our documentation is living. We are always making changes and adding more content. If you have feedback about the documentation, please open an issue in this repo. If you are interested in submitting a change to our documentation page, please review the contribution guidelines and submit a pull request.

How do I use the nteract desktop application?

To get started with the nteract desktop app, head over to the nteract homepage to download the application for your operating system.

Once you've download the app, head over to our documentation page for tutorials and guides on using the app for your data analysis and science workflows.

Supporting nteract

nteract is a non-profit open-source organization fiscally sponsored by NumFOCUS. If you are interested in supporting development on nteract, please consider making a recurring donation.

Development on nteract is also supported by the following organizations.

Netflix Logo Microsoft Logo
Gordon and Betty Moore Foundation Logo Plotly Logo

semiotic-docs's People

Contributors

dependabot[bot] avatar dgwyer avatar emeeks avatar hydrosquall avatar jdetle avatar mph006 avatar salsager avatar susielu avatar trisianto avatar willingc avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

semiotic-docs's Issues

yarn.lock points to internal netflix npm url

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!

"Copy Full Code" not working on Safari

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:

document.execCommand("copy")

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

Allow CSS from examples to be copied to clipboard

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.

[migration] Copy Examples from Old Documentation Site

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.

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.

Add curated list of user examples

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.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.