docs.notifly.tech

This repo contains the website configuration and documentation powering the Notifly Documentation.

Contents

• Getting started
• Contributing

✈️ Getting started

Prerequisites

1. Git.
2. Node (version 12 or greater).
3. A fork of the repo (for any contributions).
4. A clone of the notifly-docs repo.

Installation

1. Run npm install to install the website's workspace dependencies.

Running locally

1. npm run write-translations -- --locale ko to generate translations for Korean language.
2. npm run start to start the development server (powered by Docusaurus).
   • npm run start -- --locale ko to start the server in Korean.
3. Open http://localhost:3000/ site in your favorite browser.
4. NOTE: Each locale is a distinct standalone single-page application: it is not possible to start the Docusaurus sites in all locales at the same time.

Directory Structure

The following is a high-level overview of relevant files and folders. Sidebar automatically detects the directory structure.

└── /docs # default, english
    ├── client-sdk
    ├── http-api
    └── intro.md
└── /i18n/ko # korean translation
    └── docusaurus-plugin-content-docs/current # translation data the docs plugin needs
    │   └── current
    │       ├── client-sdk
    │       ├── http-api
    │       └── intro.md
    └── ...

👏 Contributing

Create a branch

1. git checkout main from any folder in your local notifly-docs repository.
2. git pull origin main to ensure you have the latest main code.
3. git checkout -b the-name-of-my-branch to create a branch.

Make the change

1. Follow the "Running locally" instructions.
2. Save the files and check in the browser.
3. Some changes may require a server restart to generate new files. (Pages in docs always do!)

Test the change

If possible, test any visual changes in all latest versions of the following browsers:

• Chrome and Firefox on the desktop.
• Chrome and Safari on mobile.

Push it

1. Run npm run format to ensure your changes are consistent with other files in the repo.
2. git add -A && git commit -m "feat: My message" to stage and commit your changes.
   • replace My message with a commit message, such as Fixed header logo on Android
   • Follow the rules of Conventional Commits
3. git push my-fork-name the-name-of-my-branch
4. Go to the notifly-docs repo and you should see recently pushed branches.
5. Follow GitHub's instructions.
6. Describe briefly your changes (in case of visual changes, please include screenshots).