docs(contribute): Add contributor guide #481
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Add community index page with contribution router - Add contributing guides: core-sdk, documentation, feature-proposals - Add extensions docs: ecosystem overview, publishing guide, best practices - Update community-packages.md to be the catalog page
Updates documentation for comprehensive community contribution support - Add introductory context to each major section explaining purpose and navigation - Expand core-sdk.md with detailed development workflow, pre-commit hooks explanation, and quality requirements - Enhance documentation.md with comprehensive style guidelines and code example requirements - Improve feature-proposals.md with detailed RFC process timeline and template guidance - Expand extensions/index.md with characteristics of each tier and partnership process details - Enhance publishing.md with step-by-step guidance, semantic versioning examples, and discoverability tips - Improve best-practices.md with detailed tables showing why principles matter and implementation guides - Add lead-in sentences to all tables and lists throughout for better context - Include cross-references to related documentation and reference materials - Match collaborative 'we' style consistent with existing user-guide documentation
Refactor community documentation to be more action-oriented - Rename 'extensions' to 'publishing' to be more concrete and actionable - Rewrite index.md with clear 'I want to...' sections instead of tables - De-emphasize tier system - move to brief context section - Add strands.my reference to community catalog - Update all internal links from extensions/ to publishing/ - Simplify 'Why we don't accept tools' section to be more concise - Retitle files: 'Publishing your component' instead of 'extensions' - Add 'Community resources' section with catalog link
- Separate Community (catalog/ecosystem) from Contribute (how to help) - Add new contribute section with core-sdk, documentation, feature-proposals, extensions guides - Create ADR process in adrs/ folder with template - Add team docs (TENETS, DECISIONS, API_BAR_RAISING) to root team/ folder - Add extensibility and community health strategy as ADRs - Update feature proposals to require issue first, ADR merge = go-ahead - Fix broken links and naming conventions (strands-agents topic) - Remove timeline commitments from ADR process - Delete old community/contributing and community/publishing folders
Contributor
Documentation Deployment CompleteYour documentation preview has been successfully deployed! Preview URL: https://d3ehv1nix5p99z.cloudfront.net/pr-481/ |
mkmeral
changed the title
- Fix docs setup: use pip install -e . instead of requirements.txt - Add hatch run prepare and npm run check as single commands for quality checks - Add 'Find something to work on' section with ready-for-contribution links - Link feature proposals from breaking changes guidance - Rename template repo to strands-python-extension-template
Contributor
Documentation Deployment CompleteYour documentation preview has been successfully deployed! Preview URL: https://d3ehv1nix5p99z.cloudfront.net/pr-481/ |
Contributor
Documentation Deployment CompleteYour documentation preview has been successfully deployed! Preview URL: https://d3ehv1nix5p99z.cloudfront.net/pr-481/ |
- Reframe extensions.md as publishing guide, not building guide - Slim down to essentials with link to template - Update index.md to match new framing - Fix arrow link patterns in community-packages.md
Contributor
Documentation Deployment CompleteYour documentation preview has been successfully deployed! Preview URL: https://d3ehv1nix5p99z.cloudfront.net/pr-481/ |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Adds a new Contribute section to the docs site, providing clear guidance for developers who want to contribute to Strands.
This implements the contributor documentation strategy discussed in #1535. The key insight: we need to clearly separate "how to contribute" from "what the community has built" — and make it easy for contributors to find the right path based on what they want to do.
What's new
Contribute section (
docs/contribute/)ADR process (
adrs/)Team documentation (
team/)Why this structure
From the discussion: contributors need different paths based on their intent. Someone fixing a bug has different needs than someone building a Slack integration. The table format on the overview page makes it easy to find the right guide.
Extensions get their own guide because we don't accept external tools to the core repo (security/maintenance burden). Instead, we provide a template and list community packages in the catalog.
Related Issues
Implements #1535
Type of Change
Checklist
mkdocs serveBy submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.