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.

Sign up for GitHub

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

Jump to bottom

Improve Documentation #28

Open
6 of 14 tasks
bollwyvl opened this issue Apr 11, 2021 · 2 comments
Open
6 of 14 tasks

Improve Documentation #28

bollwyvl opened this issue Apr 11, 2021 · 2 comments
Labels
documentation Improvements or additions to documentation
Milestone
1.1.1

Comments

@bollwyvl
Copy link

bollwyvl commented Apr 11, 2021 •
edited
Loading

Elevator Pitch

Build a docs site, and offer more in-app docs.

Motivation

There are a lot of features, but you kind of have to go find them.

Design Ideas

tutorial

  • jupyterlab-tour
    • one or two in core
    • one or two in export

site

  • content
    • tutorial
    • use cases
    • api
    • configuration
    • extending
  • infrastructure
    • pydata-sphinx-theme
    • mystnb
    • integrate reports from unit and acceptance tests
    • hunspell
    • pytest-check-links
    • publish to gh-pages
    • publish to rtd
@bollwyvl bollwyvl added enhancement New feature or request documentation Improvements or additions to documentation and removed enhancement New feature or request labels Apr 11, 2021
@bollwyvl bollwyvl added this to the 1.0.1 milestone Apr 11, 2021
@bollwyvl bollwyvl changed the title Add Documentation Site Improve Documentation Apr 11, 2021
@bollwyvl bollwyvl pinned this issue Apr 11, 2021
@bollwyvl bollwyvl modified the milestones: 1.1.0, 1.1.1 May 25, 2021
@richtong
Copy link

So how do you use this, I'm a little confused but it looks really cool to create a poster like that!

@bollwyvl
Copy link
Author

Welp, the current effort is currently focused on the docs site: https://ipydrawio.rtfd.io

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

No branches or pull requests
2 participants
@bollwyvl @richtong