RDoc-3361 Updated readme.md

Author: Lwiel

README.md

@@ -1,41 +1,128 @@
-# Website
+# RavenDB Documentation
 
-This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
+This documentation is built using [Docusaurus](https://docusaurus.io/), an open-source modern static website generator.
+
+## Cloning the repository
+
+To clone the repository and checkout the `main` branch:
+
+```bash
+git clone https://github.com/ravendb/docs.git
+cd docs
+git checkout main
+```
+
+## Contributing
+1. Open the markdown file you want to change, commit the changes, and create a pull request.
+2. Describe the changes made in the commits and pull request description.
 
 ## Installation
 
 ```bash
-yarn
+npm install
 ```
 
-## Local Development
+## Local development
 
 ```bash
-yarn start
+npm run start
 ```
 
-This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
+This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server (hot reload).
 
 ## Build
 
 ```bash
-yarn build
+docusaurus build
 ```
 
 This command generates static content into the `build` directory and can be served using any static contents hosting service.
 
-## Deployment
+Note it may be necessary to increase Node.js max memory usage, e.g. to 8 GB  
+```bash
+$env:NODE_OPTIONS="--max-old-space-size=8192"
+```
 
-Using SSH:
+## Serving static content
+
+Static content can be served using a static file server, such as [serve](https://www.npmjs.com/package/serve):
 
 ```bash
-USE_SSH=true yarn deploy
+npm run serve
 ```
 
-Not using SSH:
+## Documentation structure
+
+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
-GIT_USER=<Your GitHub username> yarn deploy
+npm run docusaurus docs:version version_label
 ```
 
-If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
+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.
+
+## Modifying latest version
+
+To modify the latest version of the documentation, you can edit the files in the `docs` directory. 
+
+Any changes made here will be reflected in the latest version of the documentation.
+
+## Modifying previous versions
+
+To modify a previous version of the documentation, you can edit the files in the `versioned_docs/version-version_label` directory.
+
+Versions are entirely separate, so changes made for one version will not affect other versions.
+
+## Docusaurus components
+
+- `Tabs` and `TabItem`: Create tabbed content for organizing related information.
+  ```javascript
+  <Tabs>
+  <TabItem value="rql" label="RQL">
+    // RQL Query
+    from Orders
+    where Total > 100
+  </TabItem>
+  <TabItem value="linq" label="LINQ">
+    // LINQ C# code
+    var orders = session
+    .Query<Order>()
+    .Where(x => x.Total > 100)
+    .ToList();
+  </TabItem>
+  </Tabs>
+  ```
+- `CodeBlock`: Displays formatted code snippets with syntax highlighting.
+  ```javascript
+  <CodeBlock language="csharp">
+  {`
+    // Call 'Execute' directly on the index instance
+    new Orders_ByTotal().Execute(store);
+  `}
+  </CodeBlock>
+  ```
+- `Admonition`: Shows callout boxes for notes, warnings, tips, etc.
+  ```javascript
+  <Admonition type="note" title="Important">
+    Remember to back up your data before making major changes.
+  </Admonition>
+  ```
+## Custom components
+
+Apart from the standard Docusaurus components, this documentation uses the following custom components 
+- `LanguageSwitcher`: A component responsible for handling switching between different language versions of the documentation. Languages supported by particular document are stored in `supportedLanguages` array.
+    ```javascript
+    export const supportedLanguages = ["csharp", "java", "nodejs"];
+  
+    <LanguageSwitcher supportedLanguages={supportedLanguages} />
+    ```
+- `LanguageContent`: A component that displays documentation content based on the selected language.
+    ```html
+    <LanguageContent language="csharp">
+        <!-- Content specific to C# language -->
+    </LanguageContent>
+    ```