From cd088c5b905a41f51ab675e2cbc0353b4ec713f3 Mon Sep 17 00:00:00 2001 From: Taras <9948629+taraspos@users.noreply.github.com> Date: Fri, 1 Nov 2024 16:49:30 +0000 Subject: [PATCH 1/3] Improve readme --- README.md | 40 +++++++++++++++++++--------------------- 1 file changed, 19 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index cbc5d06..240b58a 100644 --- a/README.md +++ b/README.md @@ -68,19 +68,17 @@ Everything else is more or less straightforward Docusaurus code. ### Folder structure -`content` – folder for docs content. -`scripts` – helper CLI scripts. -`server` – code for plugins, and config parsing. -`src` - forntend-related files. -`src/component` – components ported from the old site, mostly header-related. -`src/styles` – css used in header. -`src/theme` – overrides for default theme files of Docusaurus -`src/utls` – client-side utils. -`staitc` - static files for the site: manifests, favicons, etc. - -`docs`, `versioned_docs` are `versioned_sidebars` – folders for docs content that will be automatically populated by script. - -`data` is a folder for sanity content. +- `content` – folder for docs content. +- `scripts` – helper CLI scripts. +- `server` – code for plugins, and config parsing. +- `src` - forntend-related files. +- `src/component` – components ported from the old site, mostly header-related. +- `src/styles` – css used in header. +- `src/theme` – overrides for default theme files of Docusaurus +- `src/utls` – client-side utils. +- `staitc` - static files for the site: manifests, favicons, etc. +- `docs`, `versioned_docs` are `versioned_sidebars` – folders for docs content that will be automatically populated by script. +- `data` is a folder for sanity content. ### `config.json` format @@ -104,13 +102,13 @@ If no versions are marked as `current`/`latest`, last version in alphabetical or ### CLI commands -`yarn git-update` – update git modules. -`yarn prepare-files` – copy files from `content` to docusaurus folders. -`yarn prepare-sanity-data` - fetching and saving data form navigation for Sanity. -`yarn start` – start server in dev mode. -`yarn build` - buld static site. -`yarn swizzle` - used to eject files from default Docusaurus theme to `src/theme` folder. `see [swizzling](https://docusaurus.io/docs/swizzling). -`yarn serve` – server static files. -`yarn typecheck` - check types. +- `yarn git-update` – update git modules. +- `yarn prepare-files` – copy files from `content` to docusaurus folders. +- `yarn prepare-sanity-data` - fetching and saving data form navigation for Sanity. +- `yarn start` – start server in dev mode. +- `yarn build` - buld static site. +- `yarn swizzle` - used to eject files from default Docusaurus theme to `src/theme` folder. `see [swizzling](https://docusaurus.io/docs/swizzling). +- `yarn serve` – server static files. +- `yarn typecheck` - check types. For other commands see [Docusaurus docs](https://docusaurus.io/docs/cli#docusaurus-cli-commands). From ad394b5f25d9c7c45cfbcc3fca342f1c3e032556 Mon Sep 17 00:00:00 2001 From: Taras <9948629+taraspos@users.noreply.github.com> Date: Tue, 5 Nov 2024 15:57:29 +0000 Subject: [PATCH 2/3] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 240b58a..9443723 100644 --- a/README.md +++ b/README.md @@ -82,7 +82,7 @@ Everything else is more or less straightforward Docusaurus code. ### `config.json` format -``` +```typescript type Version = { name: string; // should be the same as the folder in `content` branch: string; // name of the original git branch From d03f0cf775d4df35079c202c32e12b921622aca3 Mon Sep 17 00:00:00 2001 From: Taras <9948629+taraspos@users.noreply.github.com> Date: Tue, 5 Nov 2024 21:23:09 +0000 Subject: [PATCH 3/3] Apply suggestions from code review Co-authored-by: Paul Gottschling --- README.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 9443723..814f827 100644 --- a/README.md +++ b/README.md @@ -68,17 +68,17 @@ Everything else is more or less straightforward Docusaurus code. ### Folder structure -- `content` – folder for docs content. +- `content` – pre-migration docs content. - `scripts` – helper CLI scripts. -- `server` – code for plugins, and config parsing. -- `src` - forntend-related files. +- `server` – code for plugins and config parsing. +- `src` - frontend-related files. - `src/component` – components ported from the old site, mostly header-related. -- `src/styles` – css used in header. -- `src/theme` – overrides for default theme files of Docusaurus -- `src/utls` – client-side utils. -- `staitc` - static files for the site: manifests, favicons, etc. -- `docs`, `versioned_docs` are `versioned_sidebars` – folders for docs content that will be automatically populated by script. -- `data` is a folder for sanity content. +- `src/styles` – CSS used in the site header. +- `src/theme` – overrides for the default theme files of Docusaurus. +- `src/utils` – client-side utils. +- `static` - static files for the site: manifests, favicons, etc. +- `docs`, `versioned_docs` and `versioned_sidebars` – folders for Docusaurus site content that will be automatically populated by a script (`yarn prepare-files`). +- `data` is a folder for content pulled from Sanity CMS. ### `config.json` format @@ -102,12 +102,12 @@ If no versions are marked as `current`/`latest`, last version in alphabetical or ### CLI commands -- `yarn git-update` – update git modules. -- `yarn prepare-files` – copy files from `content` to docusaurus folders. -- `yarn prepare-sanity-data` - fetching and saving data form navigation for Sanity. +- `yarn git-update` – update git submodules. +- `yarn prepare-files` – copy files from `content` to folders used by Docusaurus. +- `yarn prepare-sanity-data` - fetching and saving data from Sanity CMS. - `yarn start` – start server in dev mode. - `yarn build` - buld static site. -- `yarn swizzle` - used to eject files from default Docusaurus theme to `src/theme` folder. `see [swizzling](https://docusaurus.io/docs/swizzling). +- `yarn swizzle` - used to eject files from the default Docusaurus theme to the `src/theme` folder. See [swizzling](https://docusaurus.io/docs/swizzling). - `yarn serve` – server static files. - `yarn typecheck` - check types.