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

feat: add Vega-Lite docset #3383

Merged

Conversation

hydrosquall
Copy link
Contributor

@hydrosquall hydrosquall commented Aug 9, 2021

Motivation

  • Improve developer experience for users of the Vega-Lite data visualization library by enabling offline browsing of examples + spec documentation
  • Screenshot:

Image 2021-08-08 at 11 09 48 PM

Features

  • See generator script for the most current listing, built using guidelines from checklist and generation guide
    • No version mentioned in Info.plist
    • All pages work offline. Some pages will look better when online (I originally tried loading the data folder of CSV and JSON too, but it appears Dash doesn't run a local fileserver, so the docs scripts unable to fetch them with XMLHttpRequest
    • Provided table of contents for all the pages under Categories using URL encoded item names
    • Removed the sidebar on the specification pages, as requested in the checklist
    • Provided 2 icons by resizing the official assets, see feat: add square Vega-Lite color logos @ 128 , 32, 16 pixels vega/logos#1
    • JS is enabled, see any of the Samples to test
    • Index page is set (Visit Main Page)
    • All links in the docset index are free of newlines and extra spacing.

@Kapeli
Copy link
Owner

Kapeli commented Aug 9, 2021

Thank you! 👍

One small issue:

Found directory in main index: Entry with row id "186" and path "docs" at "vega-lite.docset"

The name of the entry is "Overview". It causes Dash to show a 404 page.

@hydrosquall
Copy link
Contributor Author

hydrosquall commented Aug 9, 2021

#3383 (comment)

@Kapeli thanks! Filed an issue to look into this.

(Update: fixed in #3385 )

@hydrosquall hydrosquall deleted the cameron.yick/add-vega-lite-docset branch August 9, 2021 14:57
This was referenced Aug 14, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants