Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
The diff you're trying to view is too large. We only load the first 3000 changed files.
42 changes: 35 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,13 +60,41 @@ The documentation is organized into two main directories
- `docs`: Contains the documentation files for latest RavenDB version.
- `versioned_docs`: Contains the documentation files for all other RavenDB versions.

## Adding new version

```bash
npm run docusaurus docs:version version_label
```

This command creates a new version of the documentation by adding `version-version_label` subdirectory to `versioned_docs` directory, which contains a snapshot of `docs` directory.
## Adding a new version

To add a new documentation version:

1. Create a snapshot of the current version in the `versioned_docs` directory.
Use:
```bash
npm run docusaurus docs:version version_label
```
2. Make the new version selectable in the sidebar by updating the current version number in the `docs` property of the `docusaurus.config.js` file.

E.g., to add version `7.2`:
* Create a version for `7.1`
```bash
npm run docusaurus docs:version 7.1
```
* Set `7.2` as the current docs version.
`docusaurus.config.js` file:
```json
docs: {
sidebarPath: "sidebars.ts",
routeBasePath: "/",
includeCurrentVersion: true,
lastVersion: 'current',
versions: {
current: {
label: "7.2",
path: "7.2"
}
},
onlyIncludeVersions: getOnlyIncludeVersions(),
//editUrl:
// 'https://github.com/ravendb/docs/tree/main/'
},
```

## Modifying latest version

Expand Down
4 changes: 2 additions & 2 deletions docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,8 @@ const config: Config = {
lastVersion: 'current',
versions: {
current: {
label: "7.1",
path: "7.1"
label: "7.2",
path: "7.2"
}
},
onlyIncludeVersions: getOnlyIncludeVersions(),
Expand Down
34 changes: 33 additions & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 4 additions & 0 deletions versioned_docs/version-7.1/ai-integration/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"position": 10,
"label": "AI Integration"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"position": 3,
"label": "AI Agents"
}
Loading