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

Transition README Docs to Docusaurus-Netlify Setup #641

Merged
merged 28 commits into from
Dec 2, 2023

Commits on Nov 21, 2023

  1. Configuration menu
    Copy the full SHA
    5f2e027 View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    0ac6764 View commit details
    Browse the repository at this point in the history

Commits on Nov 22, 2023

  1. Configuration menu
    Copy the full SHA
    bc12741 View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    5cd9946 View commit details
    Browse the repository at this point in the history
  3. Remove remark-typescript-tools from dependencies

    - Remove remark-typescript-tools as it is incompatible with docusaurus v3.
    - Replace it with gulp-preserve-typescript-whitespace and some utility functions to achieve the same results.
    - This happened to work out somewhat even better since the build time for docs is reduced.
    - It also simplifies things since we go straight from TS -> MDX instead of MDX -> TS -> MDX.
    aryaemami59 committed Nov 22, 2023
    Configuration menu
    Copy the full SHA
    3c11315 View commit details
    Browse the repository at this point in the history
  4. Add link components

    - Copy CSS from Redux-toolkit.
    - Add external and internal link components for reusability and performance.
    - Add introduction section from README to website.
    - Move static assets to docs folder.
    - Replace markdown links with component links.
      -  This was done because docusaurus has made some improvements with regards to links (preloading, prefetching, etc) as well as broken link detection.
    aryaemami59 committed Nov 22, 2023
    Configuration menu
    Copy the full SHA
    857d378 View commit details
    Browse the repository at this point in the history

Commits on Nov 23, 2023

  1. Configuration menu
    Copy the full SHA
    8cda3fe View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    89b917e View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    c7cf61a View commit details
    Browse the repository at this point in the history
  4. Configuration menu
    Copy the full SHA
    612b392 View commit details
    Browse the repository at this point in the history
  5. Remove single details closing tag from README

    - During previous commits, parts of the example for `createStructuredSelector` was accidentally removed. They are added back to README.
    - Fix minor formatting issues in README.
    aryaemami59 committed Nov 23, 2023
    Configuration menu
    Copy the full SHA
    27ef4bf View commit details
    Browse the repository at this point in the history
  6. Add remaining material from README to docs

    - Add code example files. These will get transpiled to code blocks in MDX during the build step.
    - This ensures we maintain accuracy in code examples and also prevents unnecessary redundancies by providing a single source of truth.
    - Fix the sidebar so that it somewhat resembles the RTK documentation.
    - Internal and external links still need to be converted to JSX.
    aryaemami59 committed Nov 23, 2023
    Configuration menu
    Copy the full SHA
    8e5646a View commit details
    Browse the repository at this point in the history
  7. Configuration menu
    Copy the full SHA
    7c2fa5a View commit details
    Browse the repository at this point in the history

Commits on Nov 24, 2023

  1. Configuration menu
    Copy the full SHA
    2edccc2 View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    4181264 View commit details
    Browse the repository at this point in the history
  3. Replace gulp-preserve-typescript-whitespace with compileExamples.ts

    - Remove all the `gulp` related dependencies.
    - Add `compileExamples.ts` which accomplishes the same thing with `ts-node`.
    aryaemami59 committed Nov 24, 2023
    Configuration menu
    Copy the full SHA
    1732551 View commit details
    Browse the repository at this point in the history
  4. Configuration menu
    Copy the full SHA
    7d6db5a View commit details
    Browse the repository at this point in the history
  5. Configuration menu
    Copy the full SHA
    fc73039 View commit details
    Browse the repository at this point in the history
  6. Add insertCodeExamples.ts

    - Add `insertCodeExamples` to allow insertion of code examples into MDX files.
    - Rename some of the example files.
    -  Replace markdown links with JSX links.
    aryaemami59 committed Nov 24, 2023
    Configuration menu
    Copy the full SHA
    ac07be8 View commit details
    Browse the repository at this point in the history

Commits on Nov 26, 2023

  1. Remove nested examples:build commands

    - Remove extraneous dependencies
    - Add `ts-node` to devDependencies
    - Add `prettier` and `rimraf` to devDependencies
    - Simplify the commands inside `website/package.json`
    aryaemami59 committed Nov 26, 2023
    Configuration menu
    Copy the full SHA
    fd601d6 View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    ca3d090 View commit details
    Browse the repository at this point in the history

Commits on Dec 1, 2023

  1. Configuration menu
    Copy the full SHA
    81f8b22 View commit details
    Browse the repository at this point in the history

Commits on Dec 2, 2023

  1. Configuration menu
    Copy the full SHA
    87fac6c View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    ec5b59a View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    e9b568d View commit details
    Browse the repository at this point in the history
  4. Configuration menu
    Copy the full SHA
    02cb378 View commit details
    Browse the repository at this point in the history
  5. Configuration menu
    Copy the full SHA
    cf0e950 View commit details
    Browse the repository at this point in the history
  6. Add Netlify config

    markerikson committed Dec 2, 2023
    Configuration menu
    Copy the full SHA
    0bc5987 View commit details
    Browse the repository at this point in the history