Skip to content

Release/5.0.0 docs #529

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

Merged
merged 14 commits into from
Jan 12, 2021
Merged

Release/5.0.0 docs #529

merged 14 commits into from
Jan 12, 2021

Conversation

joshuaellis
Copy link
Member

What:

  • Added a new section to the docs regarding the renderer options now availabe.
  • Updated introduction and readme (as they're in sync)
  • Updated API reference to include hydrate and re-word act to reflect renderer
  • Update snippets in API reference

Why:

Compliments the changes merged in #510 for #68

How:

Docz

Checklist:

  • Documentation updated
  • Ready to be merged

@joshuaellis joshuaellis requested a review from mpeyper January 8, 2021 12:08
@codecov
Copy link

codecov bot commented Jan 8, 2021

Codecov Report

Merging #529 (aa8b174) into beta (a25993f) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff            @@
##              beta      #529   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           12        14    +2     
  Lines          186       203   +17     
  Branches        27        29    +2     
=========================================
+ Hits           186       203   +17     
Impacted Files Coverage Δ
src/dom/pure.ts 100.00% <0.00%> (ø)
src/core/index.ts 100.00% <0.00%> (ø)
src/native/pure.ts 100.00% <0.00%> (ø)
src/server/pure.ts 100.00% <0.00%> (ø)
src/core/cleanup.ts 100.00% <0.00%> (ø)
src/helpers/promises.ts 100.00% <0.00%> (ø)
src/helpers/createTestHarness.tsx 100.00% <0.00%> (ø)
src/index.ts 100.00% <0.00%> (ø)
src/pure.ts 100.00% <0.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update a25993f...aa8b174. Read the comment docs.

Co-authored-by: Michael Peyper <mpeyper7@gmail.com>
joshuaellis and others added 2 commits January 11, 2021 12:53
Co-authored-by: Michael Peyper <mpeyper7@gmail.com>
@joshuaellis
Copy link
Member Author

Those are all the suggestion added, thanks for the grammer sweep, not sure if you wanna have one more glance over on the newest commit?

@mpeyper
Copy link
Member

mpeyper commented Jan 11, 2021

Will do, but in the morning (passed midnight here now... I've been "finishing up for the night" for about 2 hours now 😅)

@joshuaellis
Copy link
Member Author

I've been "finishing up for the night" for about 2 hours now

I know that feeling! no rush of course lol.

Co-authored-by: Michael Peyper <mpeyper7@gmail.com>
---
name: SSR Hooks
menu: Usage
route: '/usage/ssr-hooks'
Copy link
Member

Choose a reason for hiding this comment

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

I think the route and the file should become just /usage/ssr (I haven't done it as a suggestion because I can't rename the file to match).

Copy link
Member

Choose a reason for hiding this comment

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

If you do this, don't forger to update any links to this page (I saw at least one in api-reference)

@mpeyper
Copy link
Member

mpeyper commented Jan 12, 2021

I think that last round of suggestions will just about do it. Good enough for the first release anyway. If history is any indicator, there will be plenty of PRs suggesting minor edits to them anyway, regardless of how much effort we put in now 😅

@mpeyper mpeyper force-pushed the release/5.0.0-docs branch from 4ecbf4a to aa8b174 Compare January 12, 2021 09:18
@mpeyper mpeyper merged commit 2a1e448 into beta Jan 12, 2021
@mpeyper mpeyper deleted the release/5.0.0-docs branch January 12, 2021 09:24
@github-actions
Copy link

🎉 This PR is included in version 5.0.0-beta.9 🎉

The release is available on:

Your semantic-release bot 📦🚀

@github-actions
Copy link

🎉 This PR is included in version 5.0.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants