Skip to content

Add beginner onboarding documentation proposal#1505

Open
rayaparsa-a11y wants to merge 6 commits into
supabase:mainfrom
rayaparsa-a11y:main
Open

Add beginner onboarding documentation proposal#1505
rayaparsa-a11y wants to merge 6 commits into
supabase:mainfrom
rayaparsa-a11y:main

Conversation

@rayaparsa-a11y
Copy link
Copy Markdown

Summary

This contribution proposes beginner-focused onboarding improvements for the supabase-py documentation.

Changes include:

  • Clarification of Python virtual environment setup and the uv workflow
  • Explanation of synchronous vs asynchronous clients
  • Common beginner troubleshooting examples
  • Suggested onboarding sequence for first-time contributors
  • Recommended locations for future documentation integration

Motivation

While reviewing the repository as a new contributor, I identified several areas where additional explanation could make onboarding easier for beginners who may be unfamiliar with Python environments, async workflows, and repository navigation.

These notes are intended as a documentation-focused contribution and starting point for discussion around improving contributor onboarding.

Expand beginner onboarding notes with scope, placement table, and troubleshooting
Expand beginner onboarding notes with scope, placement table, and troubleshooting
@rayaparsa-a11y rayaparsa-a11y requested review from a team and o-santi as code owners May 30, 2026 01:55
@silentworks
Copy link
Copy Markdown
Contributor

A lot of the thinks you are mentioning in this documentation are things a python developer should already be familiar with. The aim of the project is not to teach a python developer the basics as this should be learnt by doing research and building their skills. This document will just become a maintainers burden without much gain from it.

@rayaparsa-a11y
Copy link
Copy Markdown
Author

Thank you for the feedback. I appreciate you taking the time to review the proposal. My perspective came from exploring the repository as a first-time contributor and noting areas that I found confusing during onboarding. I understand your concern about documenting general Python concepts that may be outside the scope of this project. I'll revisit the proposal and look for ways to focus more on repository-specific onboarding and contributor guidance.

Thanks again for the input!

…er feedback

Removes general Python onboarding content (virtual environments, sync/async basics, common Python errors) in response to maintainer feedback that such guidance falls outside the scope of supabase-py.

Replaces it with five repository-specific topics: the dual sync/async client architecture, the relationship to sister sub-libraries (postgrest-py, gotrue-py, storage3, realtime-py), v3.0 migration context, where different kinds of questions belong (issues vs Discussions vs Discord), and expectations around the local test suite.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants