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

Remove warnings and clean up getting started docs #1559

Merged

Conversation

sewera
Copy link
Collaborator

@sewera sewera commented Jan 19, 2023

Related Issues

Contains #1549. Relates to #1220 and a comment in #1033.

Summary

  • Remove superfluous warning messages (change made by @chrisk-7777).
  • Reformat docs/getting-started/*.
    • Introduce semantic line breaks in those files1.
  • Rename introduction.mdx => introduction.md2.
  • Add a description to the Comparison doc page.
  • Fix some minor language errors.
  • Reformat recipes.mdx.

Check List

  • yarn run prettier for formatting code and docs

Footnotes

  1. Semantic line breaks are a great tool for documentation maintenance. They ensure easier to navigate diffs, better raw docs readability in code editor, and make typos and language errors easier to spot. More info on semantic line breaks here.

  2. There is no need to use MDX, because standard Markdown supports HTML syntax. MDX is only needed for rendering JSX components, like React ones. More info on MDX here.

sewera and others added 2 commits January 19, 2023 15:19
Co-authored-by: Chris K <55621012+chrisk-7777@users.noreply.github.com>
@codesandbox-ci
Copy link

codesandbox-ci bot commented Jan 19, 2023

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit e072179:

Sandbox Source
React Configuration
React Typescript Configuration
React Browserify Configuration
React Snowpack Configuration
React Parcel Configuration
Next.js Configuration
@pavlobu/zustand demo Configuration

@sewera sewera marked this pull request as draft January 19, 2023 16:38
@sewera
Copy link
Collaborator Author

sewera commented Jan 19, 2023

recipes.mdx reformat is still in progress.

@sewera sewera marked this pull request as ready for review January 19, 2023 17:30
Copy link
Member

@dai-shi dai-shi left a comment

Choose a reason for hiding this comment

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

🎉

@dai-shi dai-shi merged commit 2f2fee4 into pmndrs:main Jan 20, 2023
@sewera sewera deleted the remove-warnings-and-clean-up-getting-started-docs branch January 20, 2023 00:12
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

3 participants