Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 43 additions & 0 deletions docs/sourcey-publishing-guide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Fix for Issue #53: Frantic bounty #33: Publish Sourcey docs for a maintained OSS library

# docs/sourcey-publishing-guide.md

# Guide: Publishing Sourcey Docs for an OSS Library

## Overview
This guide walks through publishing documentation on Sourcey for a maintained open-source library.

## Steps to Complete Bounty #33

### 1. Select a Maintained OSS Library
Choose a library that:
- Is actively maintained (recent commits within 6 months)
- Has inadequate or missing Sourcey documentation
- You're familiar with or can learn quickly

**Suggested candidates:**
- httpx (Python HTTP client)
- pydantic (Data validation)
- fastapi (if not already documented)
- rich (Terminal formatting)

### 2. Create Sourcey Account
1. Visit https://sourcey.dev
2. Sign up/authenticate
3. Navigate to documentation publishing section

### 3. Documentation Structure
Your docs should include:
- Getting Started guide
- Installation instructions
- Core API reference
- Common use cases/examples
- Troubleshooting section

### 4. Publish and Submit
1. Publish docs on Sourcey platform
2. Get the published documentation URL
3. Submit to https://gofrantic.com/bounties/33 with proof

## Verification
The bounty requires proof of published documentation on Sourcey for a maintained OSS library.