nickgros · dependabot · Jan 31, 2023 · Feb 1, 2023 · Feb 1, 2023 · Feb 1, 2023
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -13,7 +13,7 @@ body:
       required: true
     - label:  I understand that providing a [SSCCE](http://sscce.org/) example is tremendously useful to the maintainers.
       required: true
-    - label: I have read the [documentation](https://react-jsonschema-form.readthedocs.io/)
+    - label: I have read the [documentation](https://rjsf-team.github.io/react-jsonschema-form/docs)
       required: true
     - label: Ideally, I'm providing a [sample JSFiddle](https://jsfiddle.net/n1k0/f2y3fq7L/6/) or a [shared playground link](https://rjsf-team.github.io/react-jsonschema-form/) demonstrating the issue.
       required: false

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -19,49 +19,74 @@ jobs:
       uses: actions/setup-node@v3
       with:
         node-version: ${{ matrix.node-version }}
+        cache: 'npm'
+        cache-dependency-path: 'packages/**/package-lock.json'
     - run: npm ci
     - run: npm run lint
     - run: npm run cs-check
 
     - name: Build with Netlify badge
-      if: github.ref != 'refs/heads/main'
+      if: github.ref != 'refs/heads/main' && matrix.node-version != '14.x'
       run: npm run build
       env:
         VITE_SHOW_NETLIFY_BADGE: true
         NODE_OPTIONS: --max_old_space_size=4096
+
     - name: Build
-      if: github.ref == 'refs/heads/main'
+      if: github.ref == 'refs/heads/main' && matrix.node-version != '14.x'
       run: npm run build
       env:
         NODE_OPTIONS: --max_old_space_size=4096
 
+    # Docusaurus doesn't support Node 14. These tasks can be removed once Node 14 is EOL (May 2023)
+    - name: Build with Netlify badge (no docs)
+      if: github.ref != 'refs/heads/main' && matrix.node-version == '14.x'
+      run: npx nx run-many --target=build --exclude=docs
+      env:
+        VITE_SHOW_NETLIFY_BADGE: true
+        NODE_OPTIONS: --max_old_space_size=4096
+    - name: Build (no docs)
+      if: github.ref == 'refs/heads/main' && matrix.node-version == '14.x'
+      run: npx nx run-many --target=build --exclude=docs
+      env:
+        NODE_OPTIONS: --max_old_space_size=4096
+
     - if: matrix.node-version == '18.x'
       uses: actions/upload-artifact@v3
       with:
-        name: dist
+        name: playground
         path: packages/playground/dist
+    - if: matrix.node-version == '18.x'
+      uses: actions/upload-artifact@v3
+      with:
+        name: docs
+        path: packages/docs/build
     - run: npm test
-
-  deploy_playground:
+  deploy_playground_and_docs:
     runs-on: ubuntu-latest
     if: github.ref == 'refs/heads/main'
-    name: Deploy playground to GitHub Pages
+    name: Deploy playground and docs to GitHub Pages
     needs: [build]
     steps:
-      - name: Download built files
+      - name: Download built playground
         uses: actions/download-artifact@v3
         with:
-          name: dist
+          name: playground
           path: dist
-      - name: Deploy playground
+      - name: Download built docs
+        uses: actions/download-artifact@v3
+        with:
+          name: docs
+          path: dist/docs
+      - name: Deploy playground + docs to GitHub Pages
         uses: crazy-max/ghaction-github-pages@v3.1.0
         with:
           keep_history: true
           target_branch: gh-pages
           build_dir: dist
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-
+  # NOTE: The following workflow is deprecated. The docs are new deployed to GitHub pages above.
   docs:
     runs-on: ubuntu-latest
     steps:

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -13,6 +13,8 @@ jobs:
         uses: actions/setup-node@v3
         with:
           node-version: 18.x
+          cache: 'npm'
+          cache-dependency-path: 'packages/**/package-lock.json'
       - run: npm ci
       - run: npm run build
         env:

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -21,6 +21,9 @@ should change the heading of the (upcoming) version to include a major version b
 - Added the `idPrefix`, `idSeparator` and `rawErrors` optional props to `FieldProps` since they were missing
 
 ## Dev / docs / playground
+- Migrated latest documentation to Docusaurus, which is deployed to GitHub Pages.
+- Updated readthedocs.io documentation site to guide users to the new docs site.
+- Updated links in documentation and package README files to point to new site.
 - Updated the `custom-widgets-field` documentation for the new `FieldProps`
 
 # 5.0.1

diff --git a/README.md b/README.md
@@ -12,7 +12,7 @@
   <p align="center">
     A simple <a href="http://facebook.github.io/react/">React</a> component capable of using <a href="http://json-schema.org/">JSON Schema</a> to declaratively build and customize web forms.
     <br />
-    <a href="https://react-jsonschema-form.readthedocs.io/en/stable/"><strong>Explore the docs »</strong></a>
+    <a href="https://rjsf-team.github.io/react-jsonschema-form/docs/"><strong>Explore the docs »</strong></a>
     <br />
     <br />
     <a href="https://rjsf-team.github.io/react-jsonschema-form/">View Playground</a>
@@ -38,15 +38,15 @@
 
 ## Documentation
 
-Read our [documentation](https://react-jsonschema-form.readthedocs.io/en/latest/) on Read the Docs.
+Read our [documentation](https://rjsf-team.github.io/react-jsonschema-form/docs), powered by [Docusaurus](https://docusaurus.io/).
 
 ## Live Playground
 
-A [live playground](https://rjsf-team.github.io/react-jsonschema-form/) is hosted on gh-pages.
+A [live playground](https://rjsf-team.github.io/react-jsonschema-form/) is hosted on GitHub Pages.
 
 ## Contributing
 
-Read our [contributors' guide](https://react-jsonschema-form.readthedocs.io/en/latest/contributing/) to get started.
+Read our [contributors' guide](https://rjsf-team.github.io/react-jsonschema-form/docs/contributing) to get started.
 
 ## Credits
 

diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,3 @@
+# docs (DEPRECATED)
+
+[The react-jsonschema-form documentation has been moved here](../packages/docs)
diff --git a/docs/index.md b/docs/index.md
@@ -1,121 +1,5 @@
 # react-jsonschema-form
 
-![Build Status](https://github.com/rjsf-team/react-jsonschema-form/workflows/CI/badge.svg)
+The react-jsonschema-form docs have been moved [here](https://rjsf-team.github.io/react-jsonschema-form/docs).
 
-A simple [React](https://reactjs.org/) component capable of building HTML forms out of a [JSON schema](http://json-schema.org/).
-
-A [live playground](https://rjsf-team.github.io/react-jsonschema-form/) is hosted on GitHub Pages:
-
-<a target="_blank" href="https://rjsf-team.github.io/react-jsonschema-form/"><img alt="Playground" src="https://i.imgur.com/M8ZCES5.gif" /></a>
-
-## Philosophy
-
-react-jsonschema-form is meant to automatically generate a React form based on a [JSON Schema](http://json-schema.org/). If you want to generate a form for any data, sight unseen, simply given a JSON schema, react-jsonschema-form may be for you. If you have _a priori_ knowledge of your data and want a toolkit for generating forms for it, you might look elsewhere.
-
-react-jsonschema-form also comes with tools such as `uiSchema` and other form props to customize the look and feel of the form beyond the default themes.
-
-## Installation
-
-First install the dependencies from npm, along with a validator implementation (such as `@rjsf/validator-ajv8`):
-
-```bash
-$ npm install @rjsf/core @rjsf/utils @rjsf/validator-ajv8 --save
-```
-
-Then import the dependencies as follows:
-
-```js
-import validator from "@rjsf/validator-ajv8";
-import Form from "@rjsf/core";
-```
-
-Our latest version requires React 16+. You can also install `react-jsonschema-form` (the 1.x version) which works with React 15+.
-
-### As a script served from a CDN
-
-```html
-  <script src="https://unpkg.com/@rjsf/core/dist/core.cjs.production.min.js"></script>
-```
-
-Source maps are available at [this url](https://unpkg.com/@rjsf/core/dist/core.cjs.production.min.js.map).
-
-> Note: The CDN version **does not** embed `react` or `react-dom`. If you want other distributions (i.e. umd, esm), look [here](https://unpkg.com/@rjsf/core/dist/) for all releases
-
-You'll also need to alias the default export property to use the Form component:
-
-```js
-const Form = JSONSchemaForm.default;
-// or
-const {default: Form} = JSONSchemaForm;
-```
-
-## Usage
-
-```tsx
-import { RJSFSchema } from "@rjsf/utils";
-import validator from "@rjsf/validator-ajv8";
-
-const schema: RJSFSchema = {
-  title: "Todo",
-  type: "object",
-  required: ["title"],
-  properties: {
-    title: {type: "string", title: "Title", default: "A new task"},
-    done: {type: "boolean", title: "Done?", default: false}
-  }
-};
-
-const log = (type) => console.log.bind(console, type);
-
-render((
-  <Form schema={schema}
-        validator={validator}
-        onChange={log("changed")}
-        onSubmit={log("submitted")}
-        onError={log("errors")} />
-), document.getElementById("app"));
-```
-
-
-## Theming
-
-For more information on what themes we support, see [Using Themes](usage/themes).
-
-
-<!--
-
-disabled until https://github.com/rjsf-team/react-jsonschema-form/issues/1584 is resolved
-
-## Useful samples
-
- - Custom field template: <https://jsfiddle.net/hdp1kgn6/1/>
- - Multi-step wizard: <https://jsfiddle.net/sn4bnw9h/1/>
- - Using classNames with uiSchema: <https://jsfiddle.net/gfwp25we/1/>
- - Conditional fields: <https://jsfiddle.net/69z2wepo/88541/>
- - Advanced conditional fields: <https://jsfiddle.net/cowbellerina/zbfh96b1/>
- - Use radio list for enums: <https://jsfiddle.net/f2y3fq7L/2/>
- - Reading file input data: <https://jsfiddle.net/f9vcb6pL/1/>
- - Custom errors messages with transformErrors: <https://jsfiddle.net/revolunet/5r3swnr4/>
- - 2 columns form with CSS and FieldTemplate: <https://jsfiddle.net/n1k0/bw0ffnz4/1/>
- - Validate and submit form from external control: <https://jsfiddle.net/spacebaboon/g5a1re63/>
- - Custom component for Help text with `ui:help`: <https://codesandbox.io/s/14pqx97xl7/>
- - Collapsing / Showing and Hiding individual fields: <https://codesandbox.io/s/examplereactjsonschemaformcollapsefieldtemplate-t41dn>
-
--->
-
-## License
-
-Apache 2
-
-
-## Credits
-
-|  <img style="height: 100px !important" src="https://avatars1.githubusercontent.com/u/1066228?s=200&v=4"> |  <img style="height: 100px !important" src="https://user-images.githubusercontent.com/1689183/51487090-4ea04f80-1d57-11e9-9a91-79b7ef8d2013.png"></a> | <img style="height: 100px !important" src="https://www.netlify.com/img/global/badges/netlify-color-accent.svg" />  |
-|---|---|---|
-|This project initially started as a [mozilla-services](https://github.com/mozilla-services) project. |Testing is powered by [BrowserStack](https://www.browserstack.com/).|Deploy Previews are provided by [Netlify](https://www.netlify.com).|
-
-## Who uses react-jsonschema-form?
-
-- ...
-
-Add your own company / organization by making a [pull request](https://github.com/rjsf-team/react-jsonschema-form/pulls).
+We are in the process of migrating our versioned documentation. For documentation prior to version 5.0.0, please select the version in the bottom-right corner of this page.
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -6,36 +6,7 @@ extra_javascript: [main.js]
 
 nav:
   - Introduction: index.md
-  - Quickstart: quickstart.md
-  - Contributing: contributing.md
-  - JSON schema:
-      - Single fields: usage/single.md
-      - Objects: usage/objects.md
-      - Arrays: usage/arrays.md
-      - Definitions: usage/definitions.md
-      - Dependencies: usage/dependencies.md
-      - oneOf / anyOf / allOf: usage/oneof.md
-  - Usage:
-      - Widgets: usage/widgets.md
-      - Themes: usage/themes.md
-      - Validation: usage/validation.md
-  - Advanced Customization:
-      - Custom Widgets and Fields: advanced-customization/custom-widgets-fields.md
-      - Custom Templates: advanced-customization/custom-templates.md
-      - Custom Themes: advanced-customization/custom-themes.md
-      - Other Internals: advanced-customization/internals.md
-      - Typescript Support: advanced-customization/typescript.md
-  - API Reference:
-      - General uiSchema Reference: api-reference/uiSchema.md
-      - semantic-ui uiSchema Reference: api-reference/themes/semantic-ui/uiSchema.md
-      - chakra-ui uiSchema Reference: api-reference/themes/chakra-ui/uiSchema.md
-      - "&lt;Form /&gt; props": api-reference/form-props.md
-      - Utility functions: api-reference/utility-functions.md
-  - Migration Guides:
-      - 5.x Migration: 5.x upgrade guide.md
-      - 4.x Migration: 4.x upgrade guide.md
-      - 3.x Migration: 3.x upgrade guide.md
-      - 2.x Migration: 2.x upgrade guide.md
+
 
 markdown_extensions:
   - toc:

diff --git a/packages/antd/README.md b/packages/antd/README.md
@@ -15,7 +15,7 @@
   <p align="center">
   Ant Design theme, fields and widgets for <a href="https://github.com/rjsf-team/react-jsonschema-form/"><code>react-jsonschema-form</code></a>.
     <br />
-    <a href="https://react-jsonschema-form.readthedocs.io/en/stable/"><strong>Explore the docs »</strong></a>
+    <a href="https://rjsf-team.github.io/react-jsonschema-form/docs/"><strong>Explore the docs »</strong></a>
     <br />
     <br />
     <a href="https://rjsf-team.github.io/react-jsonschema-form/">View Playground</a>
@@ -100,7 +100,7 @@ See the general [open issues](https://github.com/rjsf-team/react-jsonschema-form
 
 ## Contributing
 
-Read our [contributors' guide](https://react-jsonschema-form.readthedocs.io/en/stable/contributing/) to get started.
+Read our [contributors' guide](https://rjsf-team.github.io/react-jsonschema-form/docs/contributing/) to get started.
 
 <!-- CONTACT -->
 

diff --git a/packages/bootstrap-4/README.md b/packages/bootstrap-4/README.md
@@ -10,7 +10,7 @@
   <p align="center">
   Bootstrap-4 theme, fields and widgets for <a href="https://github.com/mozilla-services/react-jsonschema-form/"><code>react-jsonschema-form</code></a>.
     <br />
-    <a href="https://react-jsonschema-form.readthedocs.io/en/stable/"><strong>Explore the docs »</strong></a>
+    <a href="https://rjsf-team.github.io/react-jsonschema-form/docs/"><strong>Explore the docs »</strong></a>
     <br />
     <br />
    <a href="https://rjsf-team.github.io/react-jsonschema-form/">View Playground</a>
@@ -86,7 +86,7 @@ const Form = withTheme(Bootstrap4Theme);
 
 ## Contributing
 
-Read our [contributors' guide](https://react-jsonschema-form.readthedocs.io/en/stable/contributing/) to get started.
+Read our [contributors' guide](https://rjsf-team.github.io/react-jsonschema-form/docs/contributing/) to get started.
 
 <!-- CONTACT -->
 

diff --git a/packages/chakra-ui/README.md b/packages/chakra-ui/README.md
@@ -16,7 +16,7 @@
   <p align="center">
   Chakra UI theme, fields and widgets for <a href="https://github.com/rjsf-team/react-jsonschema-form/"><code>react-jsonschema-form</code></a>.
     <br />
-    <a href="https://react-jsonschema-form.readthedocs.io/en/stable/"><strong>Explore the docs »</strong></a>
+    <a href="https://rjsf-team.github.io/react-jsonschema-form/docs/"><strong>Explore the docs »</strong></a>
     <br />
     <br />
     <a href="https://rjsf-team.github.io/react-jsonschema-form/">View Playground</a>
@@ -70,7 +70,7 @@ Exports `chakra-ui` theme, fields and widgets for `react-jsonschema-form`.
 - `framer-motion >= 5.0.0`
 - `@rjsf/core >= 2.0.0`
 
-Refer to the [rjsf installation guide](https://react-jsonschema-form.readthedocs.io/en/stable/#installation) and [chakra-ui installation guide](https://chakra-ui.com/docs/getting-started#installation) and for more details.
+Refer to the [rjsf installation guide](https://rjsf-team.github.io/react-jsonschema-form/docs/#installation) and [chakra-ui installation guide](https://chakra-ui.com/docs/getting-started#installation) and for more details.
 
 ---
 
@@ -105,7 +105,7 @@ const Form = withTheme(ChakraUITheme);
 
 ## Optional Chakra UI Theme properties
 
-- To pass additional properties to widgets, see this [guide](https://react-jsonschema-form.readthedocs.io/en/stable/form-customization/#object-additional-properties).
+- To pass additional properties to widgets, see this [guide](https://rjsf-team.github.io/react-jsonschema-form/docs/usage/objects#additional-properties).
 
 You can use `ChakraProvider`, to customize the components at a theme level.\
 And, `uiSchema` allows for the use of a `"chakra"` `"ui:option"` to customize the styling of the form widgets.
@@ -138,7 +138,7 @@ See the [open issues](https://github.com/rjsf-team/react-jsonschema-form/issues)
 
 ## Contributing
 
-Read our [contributors' guide](https://react-jsonschema-form.readthedocs.io/en/stable/contributing/) to get started.
+Read our [contributors' guide](https://rjsf-team.github.io/react-jsonschema-form/docs/contributing/) to get started.
 
 <!-- CONTACT -->
 

diff --git a/packages/core/README.md b/packages/core/README.md
@@ -15,7 +15,7 @@
   <p align="center">
   Core logic and classic Bootstrap 3 theme for <a href="https://github.com/rjsf-team/react-jsonschema-form/"><code>react-jsonschema-form</code></a>.
     <br />
-    <a href="https://react-jsonschema-form.readthedocs.io/en/stable/"><strong>Explore the docs »</strong></a>
+    <a href="https://rjsf-team.github.io/react-jsonschema-form/docs/"><strong>Explore the docs »</strong></a>
     <br />
     <br />
     <a href="https://rjsf-team.github.io/react-jsonschema-form/">View Playground</a>
@@ -88,7 +88,7 @@ See the general [open issues](https://github.com/rjsf-team/react-jsonschema-form
 
 ## Contributing
 
-Read our [contributors' guide](https://react-jsonschema-form.readthedocs.io/en/stable/contributing/) to get started.
+Read our [contributors' guide](https://rjsf-team.github.io/react-jsonschema-form/docs/contributing/) to get started.
 
 <!-- CONTACT -->
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# docs (DEPRECATED)

		[The react-jsonschema-form documentation has been moved here](../packages/docs)