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.

Sign up for GitHub

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

Improve readme #19

Merged
merged 3 commits into from
Nov 5, 2024
Merged

Improve readme #19

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cd088c5
Improve readme
taraspos Nov 1, 2024
ad394b5
Update README.md
taraspos Nov 5, 2024
d03f0cf
Apply suggestions from code review
taraspos Nov 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 20 additions & 22 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,23 +68,21 @@ 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` – pre-migration docs content.
- `scripts` – helper CLI scripts.
- `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 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

```
```typescript
type Version = {
name: string; // should be the same as the folder in `content`
branch: string; // name of the original git branch
Expand All @@ -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 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 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.

For other commands see [Docusaurus docs](https://docusaurus.io/docs/cli#docusaurus-cli-commands).
Loading