Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve readme #5

Merged
merged 2 commits into from
Nov 23, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Loading