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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

馃殌 Release v1 #656

Merged
merged 0 commits into from
Mar 20, 2019
Merged

馃殌 Release v1 #656

merged 0 commits into from
Mar 20, 2019

Conversation

pedronauck
Copy link
Member

@pedronauck pedronauck commented Feb 22, 2019

Description

This pull request introduces v1.0 with a lot of improvements and fixes. A lot of breakings changes are going into this new version too, so a migration guide is essential before release.

Main features and changes

  • Change monorepo structure (8e0cab6)
  • New docgen parse using DataServer instead of babel plugin and loader (85499a8)
  • React hooks migration (f57f987)
  • Use styled-components instead of emotion (19047fd)
  • Use @loadable/component instead of react-imported-component (18f02f2)
  • Use @reach/router instead of react-router (81a4a82)
  • Add integration with Gatsby using gatsby-theme-docz (70d40cc)
  • Remove ordering deprecated field (39660bb)
  • Change <PropsTable> to <Props> (80451b1)
  • Remove hash router support using hashRouter

Documentation task list

  • Update readme
  • Write migration guide
  • Update website documentation
  • How to create a theme using Docz
  • How to use Docz on Gatsby

@pedronauck pedronauck changed the title Release v1 Release v1 馃殌 Feb 22, 2019
@pedronauck pedronauck changed the title Release v1 馃殌 馃殌Release v1 Feb 22, 2019
@pedronauck pedronauck changed the title 馃殌Release v1 馃殌&nbsp; Release v1 Feb 22, 2019
@pedronauck pedronauck changed the title 馃殌&nbsp; Release v1 馃殌Release v1 Feb 22, 2019
@pedronauck pedronauck changed the title 馃殌Release v1 馃殌 Release v1 Feb 22, 2019
@pedronauck pedronauck changed the base branch from master to dev February 22, 2019 21:44
@hastebrot
Copy link
Contributor

Using the latest release I'm getting this error when I try to start docz dev:

$ docz dev
.../node_modules/docz/bin/index.js:2
require('docz-core').cli()
                     ^
TypeError: require(...).cli is not a function

Excerpt from package.json:

    "docz": "^1.0.0-alpha.91",
    "docz-theme-default": "^1.0.0-alpha.91",

@pedronauck
Copy link
Member Author

Yeah @hastebrot this is just a canary release, isn't a stable release yet. We're making tests on it before release the alpha version :)

@adrianschmidt
Copy link

Remove hash router support using hashRouter

Oh no! If hash router support is removed, docz-apps will no longer work on GitHub Pages 馃槶

Unless there's another way to get docz to work when hosted on GitHub Pages, please don't remove support for hash urls.

@swyxio
Copy link
Contributor

swyxio commented Mar 6, 2019

excited to see this happen! will be away for 2 weeks but looking forward to try this out once i get back

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.

None yet

4 participants