supernova-studio / exporter-documentation Goto Github PK
View Code? Open in Web Editor NEWLicense: MIT License
License: MIT License
It must be possible to use the Markdown Block in the Docs editor with URLs to MD files that are in private repos.
User docs ticket: #17
Right now we are exporting all the custom properties together with each token in token blocks, but this is often excessive amount of data. We have added the option to deselect properties within each token block so they are not shown anymore.
Certain user cannot publish their documentation. They're receiving Document deployment has failed
error toast.
Issue can be reproduced following this exact scenario below:
Docs
tabPublish
buttonAs a user I expect, that I'll be able to publish Docs
User's WS: https://cloud.supernova.io/ws/kardia/ds/17345-kardia/latest/documentation/editor
User's email: [email protected]
Logs:
Exporting full_page.pr for documentation page Overview
Exporting full_page.pr for documentation page Untitled
Exporting full_page.pr for documentation page Common
Exporting full_page.pr for documentation page Typography
Exporting full_page.pr for documentation page Overview
Exporting full_page.pr for documentation page Usage
Exporting full_page.pr for documentation page Typography
Exporting full_page.pr for documentation page Untitled
Exporting full_page.pr for documentation page Untitled
Exporting full_page.pr for documentation page Layout
Exporting full_page.pr for documentation page Typography
Exporting full_page.pr for documentation page Introduction
Exporting full_page.pr for documentation page Overview
Exporting full_page.pr for documentation page Tools and resources
Exporting full_page.pr for documentation page Color Pairings
Exporting full_page.pr for documentation page Buttons
Exporting full_page.pr for documentation page Switch or Checkbox
Exporting full_page.pr for documentation page Usage
Exporting full_page.pr for documentation page Icons
Exporting full_page.pr for documentation page Code
Exporting full_page.pr for documentation page Design Principles
Exporting full_page.pr for documentation page Usage
Exporting full_page.pr for documentation page Health Professional
Exporting full_page.pr for documentation page Patient
Exporting full_page.pr for documentation page Form validation
Exporting full_page.pr for documentation page Illustrations
Exporting full_page.pr for documentation page Styles
Exporting full_page.pr for documentation page Code
Exporting full_page.pr for documentation page Usage
Exporting full_page.pr for documentation page Webkits
Exporting full_page.pr for documentation page Styles
Exporting full_page.pr for documentation page Untitled
Exporting full_page.pr for documentation page Colors
Exporting full_page.pr for documentation page Color palette
Exporting full_page.pr for documentation page Design
Exporting full_page.pr for documentation page Code
Exporting index_page.pr
Exporting search_index.pr
Exporting custom_styling.pr
Exporting sitemap.pr
Copying asset(s) to assets
Finished copying bundled resources(s) from *
Finished exporting source custom_styling.pr
Finished exporting source index_page.pr
Finished exporting source search_index.pr
Finished exporting source sitemap.pr
Finished exporting source full_page.pr for documentation page Untitled
Finished exporting source full_page.pr for documentation page Untitled
Finished exporting source full_page.pr for documentation page Webkits
Finished exporting source full_page.pr for documentation page Typography
Finished exporting source full_page.pr for documentation page Design Principles
Finished exporting source full_page.pr for documentation page Illustrations
Finished exporting source full_page.pr for documentation page Color Pairings
Finished exporting source full_page.pr for documentation page Health Professional
Finished exporting source full_page.pr for documentation page Patient
Finished exporting source full_page.pr for documentation page Form validation
Finished exporting source full_page.pr for documentation page Color palette
Finished exporting source full_page.pr for documentation page Untitled
Finished exporting source full_page.pr for documentation page Overview
Finished exporting source full_page.pr for documentation page Styles
Finished exporting source full_page.pr for documentation page Code
Finished exporting source full_page.pr for documentation page Common
Finished exporting source full_page.pr for documentation page Usage
Finished exporting source full_page.pr for documentation page Styles
Finished exporting source full_page.pr for documentation page Code
Finished exporting source full_page.pr for documentation page Typography
Finished exporting source full_page.pr for documentation page Usage
Finished exporting source full_page.pr for documentation page Layout
Finished exporting source full_page.pr for documentation page Icons
Finished exporting source full_page.pr for documentation page Usage
Finished exporting source full_page.pr for documentation page Typography
Finished exporting source full_page.pr for documentation page Overview
Finished exporting source full_page.pr for documentation page Code
Finished exporting source full_page.pr for documentation page Design
Finished exporting source full_page.pr for documentation page Switch or Checkbox
Finished exporting source full_page.pr for documentation page Tools and resources
Finished exporting source full_page.pr for documentation page Untitled
Finished exporting source full_page.pr for documentation page Buttons
Finished exporting source full_page.pr for documentation page Colors
Finished exporting source full_page.pr for documentation page Introduction
Finished exporting source full_page.pr for documentation page Usage
Finished exporting source full_page.pr for documentation page Overview
Writing index.html
Writing si.js
Writing assets/css/custom.css
Writing sitemap.xml
Writing /components/overview-1.html
Writing /untitled.html
Writing /foundations/tone-of-voice/common.html
Writing /kardia-web/typography.html
Writing /foundations/overview-1.html
Writing /kardia-web/health-professional-platform/components/button/usage-1.html
Writing /kardia-web/health-professional-platform/typography-1.html
Writing /kardia-web/patient-platform/untitled.html
Writing /untitled-1.html
Writing /kardia-web/health-professional-platform/layout.html
Writing /kardia-web/health-professional-platform/typography.html
Writing /about-kardia/introduction.html
Writing /kardia-web/health-professional-platform/components/overview-1.html
Writing /email/tools-and-resources.html
Writing /foundations/color/color-pairings.html
Writing /email/components/buttons.html
Writing /foundations/ux-guidelines/switch-or-checkbox.html
Writing /kardia-web/health-professional-platform/components/button/usage-1.html
Writing /foundations/icons-1.html
Writing /kardia-web/health-professional-platform/components/button/code-1.html
All generated files must be unique, but there were more items produced for path /kardia-web/health-professional-platform/components/button/usage-1.html
Write user documentation for using markdown blocks with content from private repositories, which is enabled through a custom property.
If the table is "Fit to the page width" on published Docs it's slightly scrollable horizontally.
Issue can be reproduced following this exact scenario below:
Docs
Fit to the page width
(click on Gear
icon)View
buttonAs a user, I expect, that the table will exactly fit the page and won't be scrollable.
https://images.zenhubusercontent.com/360480164/51ff7d4e-5b3e-4301-bb53-349a82e45b9b/table_width.mov
Can we get a type: space and opacity token? Here is an example of how this might look:
https://polaris.shopify.com/tokens/space
Slack discussion:
User docs ticket:
Wireframe
Design
This is a relatively specific situation - you need to have a published page which contains some page tabs and be on a compact view (< 990 px). Once you are in compact view and click on the hamburger icon ≡
, the main menu appears. However, if you are scrolled on top, you can notice that the page tabs below overflow the menu which is supposed to be above them. See the screenshot:
Issue can be reproduced following this exact scenario below:
https://learn.supernova.io/latest/design-systems/add-design-system-content/data-sources/overview.html
.≡
icon for the main menu appears.≡
icon.When the main menu in compact view is triggered, it overflows page tabs, not the other way around.
Video:
A collection of fixes and small improvements for Default Documentation Exporter, usually reported by customers.
Slack discussion: across several channels, also reported by customers
User docs ticket: none
Wireframe
Design
alt
is empty. Test hereDeployment of Docs fails if the Shortcut block contains a title which is empty. This can happen if you add a new Shortcut block into the Docs page, assign some different page into it and delete the assigned page from the left menu right away. Once you try to publish Docs like this, their deployment fails.
Build log:
Finished exporting source index_page.pr
Finished exporting source search_index.pr
Finished exporting source sitemap.pr
Export of full_page.pr for documentation page Empty Shortcuts failed
| Failed processing template node
- Executed blueprint: "page_block_shortcut.pr"
- Executed node: [substitution]: withHTMLNewlines(shortcut.title)
- Path: "page_block_shortcut.pr:38:25"
- Debug symbol: "e4f434c3-fe76-49f7-a345-e53b9d1c127a"
- Stack: 123 loaded variables
Cannot read property 'split' of null
Issue can be reproduced following this exact scenario below:
Shortcut
block into Docs.Docs are published even when the Shortcut title is missing.
Video:
Migrate the exporter to work with the new version of custom token properties.
Figure out the details for the new render block types.
Exploration only
If you try to publish Docs with Token Group
Block in it with Render as...
set to Stack
, you can notice that the Docs deployment fails with:
Finished exporting source full_page.pr for documentation page Code
Finished exporting source full_page.pr for documentation page Overview
Export of full_page.pr for documentation page Introduction failed
| Injected blueprint execution failed
| Cannot read property 'name' of null
| Injected blueprint execution failed
| Cannot read property 'name' of null
| Injected blueprint execution failed
| Cannot read property 'name' of null
| Injected blueprint execution failed
| Cannot read property 'name' of null
| Blueprint execution failed
| Cannot read property 'name' of null
Cannot read property 'name' of null
Rendering as Table
or Grid
(regardless of how many columns) works properly.
Link to the DS: https://cloud-dev.supernova.io/ws/company-testing-ws/ds/2222-stack-fail/latest/documentation/editor
- just press Publish
Issue can be reproduced following this exact scenario below:
Token Group
Block into Docs.Token Group
block and select Render as...
-> Stack
.Docs are properly published when containing Token Group Block set to render as Stack.
Screenshot:
Build:
Continuation of #3375
Update the settings copy to match the latest UX copy guidelines.
Sentence case
Look & feel
section is renamed to Appearance
Add the ability to search by page title, in addition to sections and texts, and have it all work together within one search window.
If no text case, it returns null rather than an empty string.
There is no null
in the value of the token.
User from Juni cannot publish their documentation. They're receiving Document deployment has failed
error toast.
Issue can be reproduced following this exact scenario below:
Docs
tabPublish
buttonAs a user I expect, that I'll be able to publish Docs
User's WS: https://cloud.supernova.io/ws/juni-technology/ds/5520-juni-design-system/latest/settings/documentation/general
User's email: [email protected]
Logs:
Exporting full_page.pr for documentation page Design System Overview
Exporting full_page.pr for documentation page Overview
Exporting full_page.pr for documentation page Icon Button
Exporting full_page.pr for documentation page Tooltip
Exporting full_page.pr for documentation page Pop-confirm
Exporting full_page.pr for documentation page Modal
Exporting full_page.pr for documentation page Stepper
Exporting full_page.pr for documentation page Spin
Exporting full_page.pr for documentation page Skeleton
Exporting full_page.pr for documentation page Progress bar
Exporting full_page.pr for documentation page Message
Exporting full_page.pr for documentation page Hint Box
Exporting full_page.pr for documentation page Alert
Exporting full_page.pr for documentation page Tabs
Exporting full_page.pr for documentation page Pagination
Exporting full_page.pr for documentation page Menu item
Exporting full_page.pr for documentation page Divider
Exporting full_page.pr for documentation page Title
Exporting full_page.pr for documentation page Tag
Exporting full_page.pr for documentation page Badge
Exporting full_page.pr for documentation page Upload
Exporting full_page.pr for documentation page Switch
Exporting full_page.pr for documentation page Input
Exporting full_page.pr for documentation page Datepicker
Exporting full_page.pr for documentation page Typography
Exporting full_page.pr for documentation page Tokens Overview
Exporting full_page.pr for documentation page Border radius
Exporting full_page.pr for documentation page Colours
Exporting full_page.pr for documentation page Radio button
Exporting full_page.pr for documentation page Checkbox
Exporting full_page.pr for documentation page Divider
Exporting full_page.pr for documentation page Result
Exporting full_page.pr for documentation page Empty state
Exporting full_page.pr for documentation page Table
Exporting full_page.pr for documentation page Card
Exporting full_page.pr for documentation page List
Exporting full_page.pr for documentation page Statistic
Exporting full_page.pr for documentation page Description
Exporting full_page.pr for documentation page Collapse
Exporting full_page.pr for documentation page Avatar
Exporting full_page.pr for documentation page Component Overview
Exporting full_page.pr for documentation page Dropdown
Exporting full_page.pr for documentation page Button
Exporting full_page.pr for documentation page Quickstart Design
Exporting full_page.pr for documentation page Accessibility
Exporting full_page.pr for documentation page UX Writing
Exporting full_page.pr for documentation page Quickstart Develop
Exporting index_page.pr
Exporting search_index.pr
Exporting custom_styling.pr
Exporting sitemap.pr
Copying asset(s) to assets
Finished copying bundled resources(s) from *
Finished exporting source custom_styling.pr
Finished exporting source index_page.pr
Finished exporting source search_index.pr
Finished exporting source sitemap.pr
Finished exporting source full_page.pr for documentation page Tokens Overview
Finished exporting source full_page.pr for documentation page Quickstart Design
Finished exporting source full_page.pr for documentation page Quickstart Develop
Finished exporting source full_page.pr for documentation page Divider
Finished exporting source full_page.pr for documentation page Title
Finished exporting source full_page.pr for documentation page Divider
Finished exporting source full_page.pr for documentation page Skeleton
Finished exporting source full_page.pr for documentation page Spin
Finished exporting source full_page.pr for documentation page Tooltip
Finished exporting source full_page.pr for documentation page Badge
Finished exporting source full_page.pr for documentation page Progress bar
Finished exporting source full_page.pr for documentation page Pop-confirm
Finished exporting source full_page.pr for documentation page List
Finished exporting source full_page.pr for documentation page Tag
Finished exporting source full_page.pr for documentation page Design System Overview
Finished exporting source full_page.pr for documentation page Modal
Finished exporting source full_page.pr for documentation page Hint Box
Finished exporting source full_page.pr for documentation page Icon Button
Finished exporting source full_page.pr for documentation page Overview
Finished exporting source full_page.pr for documentation page Datepicker
Finished exporting source full_page.pr for documentation page Table
Finished exporting source full_page.pr for documentation page Description
Finished exporting source full_page.pr for documentation page Collapse
Finished exporting source full_page.pr for documentation page Tabs
Finished exporting source full_page.pr for documentation page Message
Finished exporting source full_page.pr for documentation page Stepper
Finished exporting source full_page.pr for documentation page Statistic
Finished exporting source full_page.pr for documentation page Radio button
Finished exporting source full_page.pr for documentation page Pagination
Finished exporting source full_page.pr for documentation page Card
Finished exporting source full_page.pr for documentation page Empty state
Finished exporting source full_page.pr for documentation page Result
Finished exporting source full_page.pr for documentation page Switch
Finished exporting source full_page.pr for documentation page UX Writing
Finished exporting source full_page.pr for documentation page Menu item
Finished exporting source full_page.pr for documentation page Checkbox
Finished exporting source full_page.pr for documentation page Alert
Finished exporting source full_page.pr for documentation page Component Overview
Finished exporting source full_page.pr for documentation page Upload
Finished exporting source full_page.pr for documentation page Accessibility
Finished exporting source full_page.pr for documentation page Avatar
Finished exporting source full_page.pr for documentation page Input
Finished exporting source full_page.pr for documentation page Dropdown
Finished exporting source full_page.pr for documentation page Button
Export of full_page.pr for documentation page Typography failed
| Injected blueprint execution failed
| Cannot read property 'measure' of null
| Injected blueprint execution failed
| Cannot read property 'measure' of null
| Injected blueprint execution failed
| Cannot read property 'measure' of null
| Injected blueprint execution failed
| Cannot read property 'measure' of null
| Blueprint execution failed
| Cannot read property 'measure' of null
Cannot read property 'measure' of null
Markdown rendered doesn’t render code
properly.
Issue can be reproduced following this exact scenario below:
As a user, I expect that the markdowns will render code properly
Example - click me
@illia-ks commented on Tue Sep 27 2022
Honza:
When columns in a table in Editor are reordered manually, their order is not promoted to the published documentation. It behaves as it the order of columns weren’t changed at all.
It was reported by SICPA last week, and I though I can fix it in exporter, but I can not, since the data about the order is not in the block payload.
Issue can be reproduced following this exact scenario below:
Docs
editorComponents Checklist
Docs
Published Docs
and compare with Editor
As a user I expect, that the Published Docs
will be reflecting Editor's
columns' order
Hidden page is displayed in Shortcuts
block.
Issue can be reproduced following this exact scenario below:
Docs
tabShortcuts
blockPublish
buttonView
buttonAs a user I expect, that the hidden page(s) won't be displayed in Shortcuts
block
Token blocks can now optionally include one theme that can be displayed in either override or comparison modes.
Design
The following applies to all token block types (detail, list, group)
If there is a theme assigned to the block:
The above works
The tokens blocks are exported and matching the design:
Tokens' custom properties don't fit/displayed properly in some blocks' variants. Issue is present on PROD, bot not on DEV.(same exporter versions)
Found at:
Issue can be reproduced following this exact scenario below:
Summary
As a user I expect, that the custom properties will be displayed properly at the Tokens blocks.
Token Detail - Grid (1/4 width)
Token List - Grid (4 columns)
Token Group - Table
DEV
If there're two different components in two separate groups with the same names - it'll lead to the issue with Docs
publication.
Issue can be reproduced following this exact scenario below:
Example
If you'll have such hierarchy:
Components\
Button\ (slug=button)
Design (slug=design-1)
Button\ (slug=button-1)
Design (slug=design-1)
The exporter will produce duplicated urls : /components/button/design-1.html
instead of /components/button/design-1.html
and /components/button-1/design-1.html
, which leads to the problem with publication.
As a user I expect, that I won't face an issue with Docs
publication, even if I'll have two different components with the same names in two separate groups.
Slack thread - click me
If there’re more, then 6 Figma frames in 1 row - name of the frame doesn’t fit
Issue can be reproduced following this exact scenario below:
As a user I expect, that the names at Figma block will be displayed properly, no matter how many of them in 1 row.
Icons are missing at Callout
blocks in published Docs
, they are in place in the Docs
editor. Issue present in Safari only.
Issue can be reproduced following this exact scenario below:
Docs
Callout
block(s)Docs
As a user I expect, that the Callout
blocks will have icons on published version.
Add thumbnails and descriptions to each block variant.
Design
We want to add the ability to quickly hide certain pages and groups from the export. This will be done by prefixing their name by _
.
Slack discussion: https://supernova-studio.slack.com/archives/C0MN8AGBS/p1661510808818399
_
, it will be hidden from exported siteA declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google ❤️ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.