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

docs(issue-1215): restructure top level docs #1222

Merged
merged 1 commit into from
Aug 25, 2022

Conversation

chrisk-7777
Copy link
Collaborator

@chrisk-7777 chrisk-7777 commented Aug 25, 2022

Related Issues

Fixes #1215

Summary

This restructures the docs to support the discussion here and the related issue

This PR is an initial PR to get an approximate, but decent, structure in place for the new documentation site. There will be room to iterate on it in the following documentation-tagged issues. ie. this is not the final stage of updating the docs.

  • I didn't split out the recipes. I'm not sure yet if there is value there, once I go through recipes as part of [documentation update] Individual page audit #1220 there may be room to split.
  • This PR doesn't directly address any doc content yet, it is mostly renaming and reordering.
  • There are some stub pages to be filled out in the following issues

Check List

  • yarn run prettier for formatting code and docs

image

@codesandbox-ci
Copy link

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 6d69c67:

Sandbox Source
React Configuration
React Typescript Configuration
React Browserify Configuration
React Snowpack Configuration
React Parcel Configuration

@chrisk-7777 chrisk-7777 added the documentation Improvements or additions to documentation label Aug 25, 2022
@chrisk-7777 chrisk-7777 requested a review from dai-shi August 25, 2022 10:21
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.

Looks good for a start. Thanks!

@dai-shi dai-shi merged commit b85f641 into pmndrs:main Aug 25, 2022
@chrisk-7777 chrisk-7777 deleted the issue-1215-docs branch August 25, 2022 11:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[documentation update] Add top level structure to new docs site
2 participants