mirror of
https://github.com/PR0M3TH3AN/bitvid.git
synced 2026-10-27 07:52:24 +00:00
Align /content user docs with actual upload & contribution behavior
Updated `content/docs/guides/upload-content.md` and `content/docs/getting-started.md` to accurately reflect the application's runtime behavior, specifically regarding upload workflows, CORS configuration, and routing links. - Clarified CORS instructions to distinguish between R2 (manual) and S3 (auto) configuration. - Updated example origins to be more generic (localhost). - Explicitly mentioned the "Hashtags" section in the upload form. - Clarified navigation to the Storage tab. - Fixed the broken link to the Watch History view (using hash routing). - Removed unsupported "captions" from the metadata list. - Validated changes using `tests/docs/verify-upload-claims.test.mjs`. Co-authored-by: PR0M3TH3AN <[email protected]>
This commit is contained in:
1 parent
d27952ad68
commit
4dc3691974
2 files changed
+6
-6
No files matched your search
@@ -32,7 +32,7 @@ Ready to jump in? Here's everything you need to know to start watching and shari
|
||||
2. Choose your upload mode:
|
||||
- **Upload Video**: Select a file from your device to upload directly to your Cloudflare R2 or S3-compatible bucket. If you haven't configured storage yet, click **"Configure Storage"** to enter your credentials (Account ID/Endpoint, Access Keys, Bucket Name, Public URL) in your Profile settings.
|
||||
- **External URL**: If you already host your video elsewhere, paste the HTTPS URL and (optionally) a WebTorrent magnet link.
|
||||
3. Review the rest of the form: add a description and thumbnail, decide whether to allow comments, and set the NSFW or "For Kids" toggles to match your content. Explore the metadata section to fill in captions, duration, hashtags, and other fields.
|
||||
3. Review the rest of the form: add a description and thumbnail, decide whether to allow comments, and set the NSFW or "For Kids" toggles to match your content. Explore the metadata section to fill in duration, hashtags, and other fields.
|
||||
4. Click "Publish Video" to post your content.
|
||||
|
||||
## Tips for Success
|
||||
@@ -40,7 +40,7 @@ Ready to jump in? Here's everything you need to know to start watching and shari
|
||||
- **Thumbnails:** Add eye-catching thumbnails to attract viewers.
|
||||
- **Descriptions:** Write clear descriptions to help people find your content.
|
||||
- **Visibility:** After posting, you can use the **More → Edit** action to toggle visibility or delete content.
|
||||
- **Watch History:** Encrypted watch-history sync lives in the [Watch History view](history.html), where you can clear devices or pause tracking whenever you need.
|
||||
- **Watch History:** Encrypted watch-history sync lives in the [Watch History view](/#view=history), where you can clear devices or pause tracking whenever you need.
|
||||
|
||||
## Need Help?
|
||||
|
||||
|
||||
@@ -23,7 +23,7 @@ Before you start, ensure your content meets the following requirements:
|
||||
- **Title:** **Required**.
|
||||
- **Description:** Optional.
|
||||
- **Thumbnail:** Optional.
|
||||
- **Tags (Hashtags):** Optional but highly recommended for discoverability.
|
||||
- **Tags (Hashtags):** Optional but highly recommended for discoverability. Use the dedicated "Hashtags" section in the upload form.
|
||||
|
||||
## Step-by-Step Guide
|
||||
|
||||
@@ -48,7 +48,7 @@ To allow your browser to upload files directly to the storage bucket, you must a
|
||||
```json
|
||||
[
|
||||
{
|
||||
"AllowedOrigins": ["http://127.0.0.1:5500", "https://bitvid.network"],
|
||||
"AllowedOrigins": ["http://localhost:5500", "https://bitvid.network"],
|
||||
"AllowedMethods": ["GET", "PUT", "POST", "DELETE", "HEAD", "OPTIONS"],
|
||||
"AllowedHeaders": ["*"],
|
||||
"ExposeHeaders": ["ETag", "Content-Length", "Content-Range", "Accept-Ranges"],
|
||||
@@ -56,7 +56,7 @@ To allow your browser to upload files directly to the storage bucket, you must a
|
||||
}
|
||||
]
|
||||
```
|
||||
> **Note:** Replace `AllowedOrigins` with your actual development or production origins.
|
||||
> **Note:** Replace `AllowedOrigins` with your actual origins (e.g. `http://localhost:5500` for local development, or `https://your-custom-domain.com`).
|
||||
|
||||
**S3 Compatible Providers:**
|
||||
bitvid will attempt to configure CORS automatically for generic S3 providers if your credentials have sufficient permissions. However, if uploads fail with CORS errors, apply a similar policy manually in your provider's console.
|
||||
@@ -70,7 +70,7 @@ bitvid will attempt to configure CORS automatically for generic S3 providers if
|
||||
### 4. Configure bitvid
|
||||
|
||||
1. In bitvid, open your **Profile** (click your avatar).
|
||||
2. Navigate to the **Storage** tab (or click **"Configure Storage"** in the Upload Modal).
|
||||
2. Navigate to the **Storage** tab in the sidebar menu (or click **"Configure Storage"** in the Upload Modal).
|
||||
3. Click **"Add Connection"** (or use the default form).
|
||||
4. Select **Cloudflare R2** or **S3 Compatible**.
|
||||
5. Enter your credentials:
|
||||
|
||||
Reference in new issue
Block a user