requestly / requestly-docs

requestly-docs

These docs are now being managed separately through notion. You can view the updated docs at https://developers.requestly.io

Requestly's documentation. Built with Docusauraus
Explore the docs

Getting Started

Prerequisites

• node
• npm

Installation

• Clone repo

git clone https://github.com/requestly/requestly-docs.git

• Install npm packages

npm install

• Run the app

npm start

Writing Documentation

Documentation Structure

- static
    - img
        - docs : images for docs
- docs
    - browser-extension
            - chrome : Chrome specific documentation
            - firefox : Firefox specific documentation
            - edge : Edge specific documentation
            - brave : Brave specific documentation
            - opera : Opera specific documentation
            - safari : Safari specific documentation
            - common : Common files for all the browser-extension platforms
        - desktop-app
            - mac : MacOS specific documentation
            - linux : Linux specific documentation
            - windows : Windows specific documentation
            - common : Common files for all the desktop-app platforms
        - common : Common files for browser-extension and desktop app
        - mocks
        - session-recording

Deployment

Deployments are automatically triggered when there is new push to master