Skip to main content

Contributing

The SAND ecosystem is open. Here's how to contribute.

Documentation

Fix or Improve Docs

  1. Find the page on the docs site
  2. Click "Edit this page" at the bottom
  3. Make your changes
  4. Submit a pull request

Add New Content

  1. Fork the docs repo
  2. Create your content in markdown
  3. Follow the existing structure
  4. Submit a pull request

Style Guide

  • Use clear, concise language
  • Include code examples
  • Link to related pages
  • Keep pages focused

Projects

Add Your Project

To add a project to the docs:

  1. Ensure it implements SAND protocols
  2. Create a project page following the template
  3. Submit a pull request

Project page template:

---
title: Project Name
description: One-line description
---

# Project Name

**Brief description of what it does.**

## Features

- Feature 1
- Feature 2

## Quick Start

\`\`\`bash
# Install/run commands
\`\`\`

## Links

- **Website:** [link]
- **GitHub:** [link]

## See Also

- Related pages

Contribute to Projects

Each project has its own contribution guidelines. Check their GitHub repos.

Specifications

Propose a SLIP

  1. Open an issue in solid-lite/slips
  2. Discuss the proposal
  3. Draft the specification
  4. Implement a reference
  5. Submit for review

Community

Join Discussions

  • GitHub Discussions on relevant repos
  • Nostr (find us at #sand)

Report Issues

  • Documentation issues: sandy-mount/docs
  • Project issues: Individual project repos

Code of Conduct

Be respectful. We're all working toward the same goal: a better web.