Overview

Public documentation page to guide users in deploying the Shakudo Platform. Uses docsify to generate the page.

Adding additional documentation

1. Clone this repository

2. Since we maintain most of our existing documentation on notion, we can directly export any notion page in the markdown format:

   
   1. Make sure to check the Include Subpages option if the page includes any direct links to other notion pages:
   

3. Once downloaded, unzip the file to get the markdown file

   1. If there are subpages, their markdown files will also be downloaded
   2. If there are any local content (i.e. images), they will be downloaded in a folder in the same directory level as the page in which it was used in.

4. Copy the markdown file of the desired page into the ./docs directory (or in a sub directory for organization i.e. ./docs/Deployment for deployment docs)

5. Then add the page to ./docs/_sidebar.md. For example:

   where [] specifies the sidebar name, the first parameter in () specifies the filepath from the the root ./docs to the markdown file, and the second parameter in () is an optional title for the browser tab:

   

6. If the page has links to other notion pages or uses local files/images, then they must be added manually and the links in the markdown file must be updated.

   1. For child notion pages
      1. Add the markdown file to the ./docs directory the same way as above.
      2. Ensure the parent page's markdown file links to these child pages from the root directory ./docs.
   2. For local files/images:
      1. Place them anywhere in the ./docs directory i.e. ./docs/Deployment/images for images used by deployment pages.
      2. Ensure that the page that uses local content uses the link to these files/images relative to the current page's path i.e. a markdown file in ./docs/Deployment may want to use images by linking to images/some_picture.png (which has an absolute path of ./docs/Deployment/images/some_picture.png)

7. Upon merge to the main branch, any changes should be reflected within a few minutes and displayed on (the page)[https://docs.hyperplane.dev/public-docs]

8. The notion export to markdown is not perfect and may contain formatting issues so make sure to fix these issues and/or edit the resulting markdown file. Note: You can embed HTML elements/tags within markdown files to support more custom styling.

Testing Locally

Follow the steps on the docsify docs to serve and test the page locally.