Welcome to Drips Docs 👋

This is the repository containing the Docusaurus code that is used to generate the docs for v2 of Drips. The main branch of this repository contains the docs for V2 of the Drips Protocol and app and is deployed at: docs.drips.network. The branch "v1" contains the docs for V1 of the Drips Protocol and app and is deployed at: v1.docs.drips.network.

The drips-docs repository accepts contributions via Radicle patches and GitHub pull requests. This document outlines some contributing guidelines, contact points, and other resources to make it easier to contribute to drips-docs.

docs.drips.network was created with Docusaurus. Full Docusaurus documentation can be found on their website.

If you've run into a problem or have a suggestion, browse the open issues before opening a new one.

Best Practices for Managing Contributions

• If a question is asked more than twice in a support channel, it should be added as an outstanding issue. If a resolution is found, it should be captured in the issue before it's closed or in a following pull request. Those involved in the support process should contribute to the documentation (i.e. if you answered the question, be sure to capture the outcome in the relevant documentation).

• issues should be created to capture upcoming documentation work related to new features or releases.

How to Contribute

• Get Started
• Editing Content
• Adding Content

Get Started

1. Make sure all the dependencies for the website are installed:

npm

2. Run your dev server:

npm run start

3. Publish to GH Pages

GIT_USER=<ENTER_YOUR_GITHUB-USERNAME_HERE> \
CURRENT_BRANCH=master \
USE_SSH=true \
npm run deploy

Editing an Existing Docs Page

Edit docs by navigating to docs/ and editing the corresponding document:

docs/doc-to-be-edited.md

---
title: This Doc Needs To Be Edited
---

Edit me...

For more information about docs, click here.

Adding a New Docs Page to an Existing Sidebar

1. Create the doc as a new markdown file in /docs, example docs/newly-created-doc.md:

---
id: newly-created-doc
title: This Doc Needs To Be Edited
---

My new content here...

1. Refer to that doc's ID in an existing sidebar in website/sidebars.json:

// Add newly-created-doc to the Getting Started category of docs.
{
  "docs": {
    "Getting Started": [
      "quick-start",
      "newly-created-doc" // new doc here
    ],
    ...
  },
  ...
}

For more information about adding new docs, click here.