An open API service indexing awesome lists of open source software.

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


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

Last synced: 26 days ago
JSON representation

Awesome Lists containing this project

README

          

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

Requestly Logo


Requestly's documentation. Built with Docusauraus


Explore the docs

## Getting Started

### Prerequisites
- [node](https://nodejs.org/en/)
- [npm](https://www.npmjs.com/)

### Installation
- Clone repo
```sh
git clone https://github.com/requestly/requestly-docs.git
```

- Install npm packages
```sh
npm install
```

- Run the app
```sh
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