Skip to content

Commit

Permalink
Update documentation according to the latest update
Browse files Browse the repository at this point in the history
  • Loading branch information
YuriyDurov committed Jan 10, 2024
1 parent 5b88980 commit c5e353c
Show file tree
Hide file tree
Showing 5 changed files with 6 additions and 3 deletions.
1 change: 0 additions & 1 deletion .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ on:
push:
branches:
- main
- updates
paths:
- "docs/**"
- ".github/workflows/docs.yml"
Expand Down
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
[![NuGet version](https://img.shields.io/nuget/v/Ocpi.Net.svg)](https://www.nuget.org/packages/Ocpi.Net/)
[![NuGet downloads](https://img.shields.io/nuget/dt/Ocpi.Net.svg)](https://www.nuget.org/packages/Ocpi.Net/)

## Overview

[OCPI (Open Charge Point Interface)](https://github.com/ocpi/ocpi) implementation for .Net, built with C#

| OCPI Version | Support | Progress |
Expand Down
2 changes: 1 addition & 1 deletion docs/book.toml
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
[book]
title = "OCPI.Net documentation"
title = "OCPI.Net"
2 changes: 1 addition & 1 deletion docs/src/3.implementation.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ public class OcpiCredentialsController : OcpiController
```

> ⚠️
> The OCPI.Net Versioning implementation requires your OCPI endpoint routes to start with the ocpi version number. For example, if your OCPI version is `2.2.1`, your endpoints should start with `2.2.1/`. This allows the package to determine which routes are intended for which OCPI version.
> The OCPI.Net Versioning implementation requires your OCPI endpoint routes to contain the ocpi version this route is used for. For example, if your OCPI version is `2.2.1`, your endpoints should contain `2.2.1` in them. This allows the package to determine which routes are intended for which OCPI version.
Refer to the [Versioning](7.versioning.md) section for more information on OCPI module versioning.

Expand Down
2 changes: 2 additions & 0 deletions docs/src/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Summary

# Overview

- [Introduction](1.introduction.md)
- [Architecture](2.architecture.md)
- [Implementation](3.implementation.md)
Expand Down

0 comments on commit c5e353c

Please sign in to comment.