Skip to content
This repository was archived by the owner on Mar 4, 2020. It is now read-only.

[DO NOT MERGE] Docs Version 2 #1999

Closed
wants to merge 46 commits into from
Closed

[DO NOT MERGE] Docs Version 2 #1999

wants to merge 46 commits into from

Conversation

dvdzkwsk
Copy link
Contributor

@dvdzkwsk dvdzkwsk commented Oct 2, 2019 •
edited
Loading

DO NOT MERGE! This PR exists so that I can track integration issues between the new doc site and the current Stardust build pipeline. The size of this PR will drop considerably once it is ready, since right now a lot of documentation is duplicated between /docs and /docs-v2. Also, a large portion of the additions are exclusively within yarn.lock, since Gatsby has been added as a dependency.

New Features

  • Global site search
  • Component previews
  • Server-side rendering
  • Mobile support
  • Convenient global light/dark theme toggle
  • New and updated "getting started" pages
  • Playground can toggle theme independently of global theme
  • Full screen component playground
  • Sitemap
  • Eliminates all pre-build steps for docs
  • Improved SEO (all pages have proper titles and descriptions)
  • All site content is .mdx, not Javascript.

Tradeoffs

  • While the new site is still built with React components, it does not rely on Stardust components outside of the playground and some other assorted widgets. This has mostly been a limitation of Stardust's support for server-side rendering. As that aspect of the library improves, we can replace the existing components with their Stardust variants.

Todo

  • Developer documentation
  • Port all existing content
  • Verify screener tests still work
  • Verify perf tests still work
  • Accessibility signoff

Screenshots

Screen Shot 2019-10-02 at 11 22 24 AM

Screen Shot 2019-10-02 at 11 24 12 AM

Screen Shot 2019-10-02 at 11 28 36 AM

@vercel vercel bot temporarily deployed to staging October 2, 2019 19:01 Inactive
David Zukowski and others added 23 commits October 2, 2019 12:06
Port stardust-ui-docs into stardust-ui/react fork
70fa7cc
Fix typescript issues in gulp tasks
9500504
Fix race condition with font-size detection
f85c689
Select correct template files for "learn" and "components"
fdbf820
Add component schema to page context
823db8d
Fix "start" task
23acdb4
Style/content tweaks
c147f58
Attempt to fix server-side rendering issue from Stardust
cc724a3
Switch theme for code blocks in light and dark mode
141a3ad
Improve installation page
03c5dc8
Improve component list page styles
485e668
Fix search keyboard navigation
2fe244c
Move schema cache to node_modules/.component-schema-cache
a73d860 
Gatsby is pretty aggressive with its cache purging, and these schemas
are fairly static. Moving these to node_modules helps keep the cache
more stable, speeding up the development workflow.
Upgrade doc dependencies
82bf47a
Fix bad usage of <SEO /> component
c8806d9 
The page title was being ignored because <SEO /> was rendering twice,
first with the title and again with the description. Instead, these meta
attributes should be applied to a single SEO component.
Cleanup global syntax highlighting styles
00c0ff7
Fix syntax highlighting theme collision between light and dark mode
76d4ebc
Improve page header styles on mobile
5ea27e1
More page header style tweaks for mobile
035415c
Prevent list items from on index page from animating on mount
1bac134
Categorize components
8344e96
Add theme picker back to navbar
5399f6b
Fix wording in installation steps
68b4242
@vercel vercel bot temporarily deployed to staging October 2, 2019 19:33 Inactive
@ecraig12345 ecraig12345 mentioned this pull request Dec 6, 2019
Merged
@ecraig12345
Copy link
Member

Hi, just a heads up that I made a change #2153 renaming all lib folders to utils. So the changes to lib files in this PR will need to be moved to the new location.

@dvdzkwsk dvdzkwsk closed this Dec 21, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@kuzhelov kuzhelov Awaiting requested review from kuzhelov

@layershifter layershifter Awaiting requested review from layershifter layershifter is a code owner

@levithomason levithomason Awaiting requested review from levithomason levithomason is a code owner

@miroslavstastny miroslavstastny Awaiting requested review from miroslavstastny miroslavstastny is a code owner

@mnajdova mnajdova Awaiting requested review from mnajdova

Assignees
No one assigned
Labels
❌ do not merge 🚧 WIP
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@dvdzkwsk @ecraig12345 @layershifter