doc: Add link to API docs in CONTRIBUTE.md

sg-wireless · Mar 30, 2022 · 5fda95a · 5fda95a
1 parent a34d2fa
commit 5fda95a
Showing 1 changed file with 21 additions and 9 deletions.
diff --git a/CONTRIBUTE.md b/CONTRIBUTE.md
@@ -25,6 +25,8 @@ To work on Pymakr VSC, we first need to clone the repo and install its dependenc
    npm install
    ```
 
+---
+
 ## Running the extension
 
 To run the extension, we need to open the project in VSCode and run the source code in debug mode.
@@ -41,20 +43,30 @@ To run the extension, we need to open the project in VSCode and run the source c
 
    _Hint: We can also start the task with <kbd>F5</kbd>. This shortcut always starts the last run task._
 
+---
+
 ## Testing the extension
 
 Testing is done in the same way we run the extension. Instead of clicking Run PyMakr, we click the dropdown arrow and choose `Integration Tests` or `Unit Tests`.
 
 _Hint: <kbd>F5</kbd> can be used to start the last executed task._
 
+---
+
 ## File structure
 
-| Path             | Description                                                 |
-| ---------------- | ----------------------------------------------------------- |
-| **example**      | Example projects (may be deleted for a templating approach) |
-| **media**        | Media assets                                                |
-| **node_modules** | _Node dependencies. Fully managed by `npm`._                |
-| **src**          | _Source files. See [API.md](https://github.com/pycom/pymakr-vsc/blob/next/docs/index.html) for info._            |
-| **templates**    | Templates used for erasing device / creating new projects   |
-| **test**         | Integration tests                                           |
-| **types**        | Types used for auto completion                              |
+| Path             | Description                                                                                           |
+| ---------------- | ----------------------------------------------------------------------------------------------------- |
+| **example**      | Example projects (may be deleted for a templating approach)                                           |
+| **media**        | Media assets                                                                                          |
+| **node_modules** | _Node dependencies. Fully managed by `npm`._                                                          |
+| **src**          | _Source files. See [API.md](https://github.com/pycom/pymakr-vsc/blob/next/docs/index.html) for info._ |
+| **templates**    | Templates used for erasing device / creating new projects                                             |
+| **test**         | Integration tests                                                                                     |
+| **types**        | Types used for auto completion                                                                        |
+
+---
+
+## API
+
+For API documentation, please see [Pymakr API](https://htmlpreview.github.io/?https://raw.githubusercontent.com/pycom/pymakr-vsc/next/docs/classes/PyMakr.html).