# orleans-docs

**Repository Path**: mirrors_dotnet/orleans-docs

## Basic Information

- **Project Name**: orleans-docs
- **Description**: Orleans documentation
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-10-25
- **Last Updated**: 2025-10-11

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Orleans documentation is now a part of [dotnet/docs](https://github.com/dotnet/docs/tree/main/docs/orleans)

Documentation is published on [docs.microsoft.com/dotnet/orleans](https://docs.microsoft.com/dotnet/orleans/)

⚠ Please use the [dotnet/docs](https://github.com/dotnet/docs/tree/main/docs/orleans) repository to make documentation updates.

----

# Orleans documentation

[Orleans' documentation is published here,](https://docs.microsoft.com/dotnet/orleans/)

## Building the documentation

To build the documentation you will need a copy of [DocFX](https://dotnet.github.io/docfx/) on your path.
Alternatively, on Windows, you can run `dotnet build src` to build the documentation using a version of DocFx from NuGet.

If you're on Linux/OSX you can run DocFX with Mono.

To build the documentation, run:

```
> docfx src\docfx.json
```

To view the documentation:

```
> docfx serve
```

You'll then be able to browse the website on [http://localhost:8080](http://localhost:8080)

## Editing the Documentation

Please edit the markdown files in the `src` directory.

The `toc.yml` files are used to create the menus. Any new markdown files you add will need to be included in the appropriate `toc.yml` file. This may include the `toc.yml` file at the same level in the directory structure, and possibly in the parent directory too.

All files (both markdown and html) are added to git.