Skip to content

Commit

Permalink
Update README.md with contributing section (#285)
Browse files Browse the repository at this point in the history
* Update README.md

* lint

---------

Co-authored-by: Maria Z <[email protected]>
  • Loading branch information
fabiomaienschein and ma-zah authored Oct 14, 2024
1 parent 36c17b5 commit 0757adb
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,13 @@ Click on `Use this template` to copy the Mintlify starter kit. The starter kit c
- API Reference pages
- Use of popular components

### Contributing

- screenshots can be done on Mac via Ctrl+Shift+4+Spacebar and selecting the right window
- to have the app appear as in the existing screenshots, you can install/ run our app as a PWA: in Chrome there is an icon for this within the URL bar on the right ("install Octomind"/ launch from same place)
- for simple highlighting such as boxes and arrows, you can use MacOS Preview -> Markup tools
- to update the [feature drops](https://octomind.dev/docs/changelog), take a look at the past [releases](https://github.com/OctoMind-dev/automagically/releases)

### 👩‍💻 Development

Install the [Mintlify CLI](https://www.npmjs.com/package/mintlify) to preview the documentation changes locally. To install, use the following command
Expand Down

0 comments on commit 0757adb

Please sign in to comment.