diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2a0f190..ea67a11 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -11,6 +11,26 @@ possible. - `cmd/rocketchat` - RocketChat notification service. - `cmd/slack` - Slack notification service. - `cmd/telegram` - Telegram notification service + +- Documentation + `docs` - Contains the documentation in markdown format. + - `services.md` If you are adding a new service please add documentaiton to `services.md`. + - `home.md` Is the main page rendered when docs website is loaded. + - `install.md` Contains the install instructions for different packages. + + - Checking Locally + - Docsify is used for documentation rendering from markdown, you can download + the cli and test locally before opening a pull request. + Install + ```bash + npm i docsify-cli -g + # yarn global add docsify-cli + ``` + Serve locally + ```bash + docsify serve docs + ``` + ## Commits diff --git a/README.md b/README.md index 299b7e3..8884e8e 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,7 @@
About • - Documentation • + Documentation • Supported Services • Install • Github Action • @@ -138,14 +138,14 @@ GLOBAL OPTIONS: --help, -h show help (default: false) ``` -Check [Documentation Page](https://kha7iq.github.io/docs-pingme/#/) for more details. +Check [Documentation Page](https://kha7iq.github.io/pingme/#/) for more details. ## Configuration All the flags have corresponding environment variables associated with it. You can either provide the value with flags or export to a variable. -View the [Documentation Page](https://kha7iq.github.io/docs-pingme/#/) for more details. +View the [Documentation Page](https://kha7iq.github.io/pingme/#/) for more details. ## Contributing