diff --git a/README.md b/README.md index df69187..fbb6ed2 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,28 @@ -# Plain Docs +# Plain Documentation -These are Plain's docs (https://plain.com/docs). +This is the documentation for Plain and its API which you can find here: + +**https://plain.com/docs** They are built using [Mintlify](https://mintlify.com). -To run these locally you will need Node 18.x and PNPM 8.x installed. +To run these locally you will need + +- Node 18.x +- pnpm 8.x + +To run the docs locally: -To run the docs: `pnpm install` and then `pnpm run dev`. +- Install all dependencies using `pnpm install` +- Run it using `pnpm run dev` You can run linting with `pnpm lint` + +There are some key language/style choices you should follow (and add to): + +- Key features are not uppercase e.g. "Customer cards" vs "Customer Cards" +- URL is uppercase +- 'backend' not 'back-end' +- Be consistent in which words are used for different groups of people: + - When refering to people who are helped via Plain use the name "customer" + - When refering to people who use Plain to help other people use the name "user" diff --git a/package.json b/package.json index f47f3ca..017cc95 100644 --- a/package.json +++ b/package.json @@ -1,8 +1,8 @@ { - "name": "@team-plain/docs-mintlify", + "name": "@team-plain/docs", "version": "1.0.0", "description": "Documentation for plain.com", - "main": "index.js", + "main": ".", "engines": { "node": "18.x", "pnpm": "8.x"