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

Rewrite docs with Doctocat #851

Merged
merged 54 commits into from
Aug 20, 2019
Merged

Rewrite docs with Doctocat #851

merged 54 commits into from
Aug 20, 2019

Conversation

colebemis
Copy link
Contributor

@colebemis colebemis commented Jul 29, 2019

This pull request refactors the Primer CSS documentation site to use Doctocat. The new site has feature parity with the old site (primer.style/css).

TODO

  • Remove old docs
  • Update contributing docs
  • Make sure documentation is up to date
  • Test in Chrome
  • Test in Firefox
  • Test in Safari
  • Test in Edge

@vercel
Copy link

vercel bot commented Jul 29, 2019

This pull request is automatically deployed with Now.
To access deployments, click Details below or on the icon next to each push.

Latest deployment for this branch: https://primer-css-git-doctocat.primer.now.sh

@colebemis
Copy link
Contributor Author

Safari: Nav links in the nav drawer aren't clickable if they are below the fold.

I spent most of yesterday trying to fix this bug. Turns out there is no straightforward fix. After discussing with @emplums, I think it's okay if we move forward with this pull without fixing this since it only affects macOS Safari users with a viewport of <1000px.

I filed an issue for this bug on the primer/dococat repo (primer/doctocat#56) and react-focus-lock repo (theKashey/react-focus-lock#79).

@colebemis colebemis requested a review from shawnbot August 20, 2019 21:10
Copy link
Contributor

@shawnbot shawnbot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a huge amount of great work and after clicking around on the site it seems to do everything at least as well (if not better) than our existing site. Search works great. Prefetching seems to be working nicely and page transitions are practically non-existent. And it all looks really good, down to the improved syntax highlighting. I'm sure we'll find issues, but with Doctocat in place I think they'll be a lot easier to fix than they were before. Kudos, @colebemis! 👏

@colebemis colebemis merged commit 32c9de0 into master Aug 20, 2019
@shawnbot shawnbot mentioned this pull request Aug 22, 2019
@shawnbot shawnbot deleted the doctocat branch August 22, 2019 21:41
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.

4 participants