Skip to content

Commit 6e67a6b

Browse files
committed
docs: update README to reflect project name and documentation details for CSlant API
1 parent f016dfd commit 6e67a6b

File tree

1 file changed

+14
-2
lines changed

1 file changed

+14
-2
lines changed

README.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,18 @@
1-
# Website
1+
# CSlant Api Docs
22

3-
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
3+
This project is a documentation site for the CSlant API. It is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator.
4+
5+
All OpenAPI docs are generated using the OpenAPI Generator CLI. The generated files are then copied to the `api-docs` directory in the root of the project.
6+
7+
The OpenAPI docs are then rendered using the Docusaurus Plugin OpenAPI Docs and Docusaurus Theme OpenAPI Docs.
8+
9+
### Prerequisites
10+
11+
- [Node.js](https://nodejs.org/en/download/)
12+
- [Yarn](https://classic.yarnpkg.com/en/docs/install)
13+
- [OpenAPI Generator](https://openapi-generator.tech/docs/installation)
14+
- Docusaurus Plugin OpenAPI Docs
15+
- Docusaurus Theme OpenAPI Docs
416

517
### Installation
618

0 commit comments

Comments
 (0)