Welcome to Radicle Docs 👋

This is the repository for the Radicle documentation site docs.radicle.xyz. radicle-docs 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 radicle-docs.

docs.radicle.xyz 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. We use the following label system to organize our issues.

for typos, broken links, and other quick fixes
for additions to the FAQ and Troubleshooting sections
for revisions, rewrites, and larger improvements
for feedback on structure & content
for questions that can't be answered via documentation
for improvements and fixups related to the look and feel of the docs site

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).
If a piece of unaddressed feedback is given more than three times, a issue should be created and added to the Feedback Hub to be prioritized in the following weekly sync.
issues should be created to capture upcoming documentation work related to new features or releases.
Issues will be reviewed on a rolling basis and triaged weekly by @abbey-titcomb.

How to Contribute

Get Started
Editing Content
Adding Content
Contributing

Get Started

Make sure all the dependencies for the website are installed:

yarn

Run your dev server:

yarn start

Publish to GH Pages

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

Editing Content

Editing an existing docs page

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

docs/doc-to-be-edited.md

---
id: page-needs-edit
title: This Doc Needs To Be Edited
---

Edit me...

For more information about docs, click here

Adding Content

Adding a new docs page to an existing sidebar

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..

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

Contributing

💡 We require all commits to be signed for a branch to be merged into master. Learn more on setting up commit signing here.

Contributions to radicle-docs can be made via pull requests on GitHub or through Radicle. If opening a PR, please tag any associated parties and @abbey-titcomb for visibility.

If contributing via Radicle, submit your patch for review by sending an email to abbey@monadic.xyz in the following format:

Subject line:

  *[PATCH] Description of patch*

Message body:

  *[Device ID]*
  *[Display name]*

  *Description of patch and other relevant information*

wiyarmir / radicle-docs