-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* improve readme and configs * Make link bold
- Loading branch information
Showing
2 changed files
with
23 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters