Skip to content

Conversation

@kale-stew
Copy link
Contributor

@kale-stew kale-stew commented Apr 7, 2020

Description

This PR updates react and react-static to the latest and greatest, which will both improve our dev experience and bring our docs into 2020.

Fixes #838

Remaining work to be done before this PR is g2g:

  • Add the righthand side sub-navigation bar
  • Fix accent colors (i.e. code samples) & heading sizes
  • Fix /docs so it initializes to /basic-concepts instead of 404-ing
  • Polish, extensive testing in our staging env (see the deployed demo site)

@kale-stew kale-stew added the 📖 Documentation Documentation requests or updates label Apr 7, 2020
@kale-stew kale-stew force-pushed the task/update-react-static branch 3 times, most recently from 6598327 to 3751dde Compare April 9, 2020 23:12
@kale-stew kale-stew marked this pull request as ready for review April 9, 2020 23:12
@kale-stew kale-stew added the 🤖 Dependencies Pull requests that update a dependency file label Apr 9, 2020
@kale-stew kale-stew force-pushed the task/update-react-static branch from 1c777ec to b272c71 Compare April 13, 2020 03:36
@kale-stew kale-stew force-pushed the task/update-react-static branch from 628eb27 to 6b6799c Compare April 14, 2020 17:50
- [Heroku](https://devcenter.heroku.com/articles/git#deploying-code)
- [Zeit](https://zeit.co/docs/v2/platform/deployments)
- [Surge](https://surge.sh/help/deploying-continuously-using-git-hooks)
1. If you are integrating this lib yourself, take your build and follow the linked instructions from any of (but not limited to) the following providers: [Heroku](https://devcenter.heroku.com/articles/git#deploying-code), [Zeit](https://zeit.co/docs/v2/platform/deployments), or [Surge](https://surge.sh/help/deploying-continuously-using-git-hooks).
Copy link
Contributor Author

Choose a reason for hiding this comment

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

The formatting for this list of links was weird, so I opted to keep the links inline instead.

order: 1
---

<a name="basic-concepts"></a>
Copy link
Contributor Author

Choose a reason for hiding this comment

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

We found these <a> tags were to blame for the persistent 404.


## Space

**Space** props used by [`Box`](/docs/api-reference#box), [`FlexBox`](/docs/api-reference#flex-box), [`Grid`](/docs/api-reference#grid), [`CodeSpan`](/docs/api-reference#code-span), [`Text`](/docs/api-reference#text), [`Link`](/docs/api-reference#link), [`Heading`](/docs/api-reference#heading), [`Quote`](/docs/api-reference#quote), [`Table`](/docs/api-reference#table), [`TableHeader`](/docs/api-reference#table-header), [`TableBody`](/docs/api-reference#table-body), [`TableRow`](/docs/api-reference#table-row), [`TableCell`](/docs/api-reference#table-cell), [`UnorderedList`](/docs/api-reference#unordered-list), [`OrderedList`](/docs/api-reference#ordered-list), and [`ListItem`](/docs/api-reference#list-item).
Copy link
Contributor Author

Choose a reason for hiding this comment

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

These links are known not to work locally for the time being. See #877 for more thorough tracking of this issue.

Copy link
Contributor

@carloskelly13 carloskelly13 left a comment

Choose a reason for hiding this comment

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

I have kicked the tires on this enough and I think it is in great shape! Any subsequent nits can be done in future PRs.

@kale-stew kale-stew merged commit 42714a0 into master Apr 15, 2020
@kale-stew kale-stew deleted the task/update-react-static branch April 15, 2020 15:55
kale-stew pushed a commit that referenced this pull request Apr 17, 2020
* Upgrade docs site to react-static v7 (#873)

* update packages

* consume global styles, add Loading state

* import Link from react-router-dom instead of react-static

* Improve hot reloading

* Move colors into a theme, update global-style accordingly

* Rename markdown.js

* svg cleanup - delete unused, add new

* Add 404 content

* gut static-config helpers in favor of react-static-plugin-md-pages, update deps

* add SidebarList (sub-navigation) to the Article view

* Theme improvements

* Remove anchor tags that were breaking the docs

* Style improvements

* Initalize docs/ route

* Use formidable-oss-badges instead of local svgs

* Downgrade react-static-plugin-md-pages for CI 🤞

* Add a blank index w/ content

* Use local paths in docs content

* Add Featured Badges

* Add urql and runpkg

* Use formidable-oss-badges instead of local svg

* Make sure format script reaches markdown content

* Get rid of word-break overflow

* Improve doc table formatting

* Use svg info from formidable-oss-landers

* Move public + manifest data to top-level public dirs

* Remove unused & hard to find assets, update preview pres data

* Bug/broken links (#881)

Co-authored-by: boygirl <lauren.eastridge@formidable.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

🤖 Dependencies Pull requests that update a dependency file 📖 Documentation Documentation requests or updates

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs: Upgrade to react-static v^7

3 participants