Skip to content

Commit

Permalink
Improve readme (#5)
Browse files Browse the repository at this point in the history
* improve readme and configs

* Make link bold
  • Loading branch information
mattvagni authored Nov 23, 2023
1 parent 3a9084c commit 9fdca00
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 6 deletions.
25 changes: 21 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -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"
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -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"
Expand Down

0 comments on commit 9fdca00

Please sign in to comment.