Skip to content
Merged
Show file tree
Hide file tree
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
1 change: 1 addition & 0 deletions docs/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,7 @@ extra:
min_python_version_tag: "310" # The tag version of the minimum python version
recent_python_version: "3.13" # The newest Python version known to work on all platforms
docs_python_version: "3.13" # The version of Python required to build the documentation
contribution_guide_root: contributing/guide/
social:
- icon: fontawesome/brands/github
link: https://github.com/beeware
Expand Down
2 changes: 1 addition & 1 deletion docs/en/contributing/first-time-contributors.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# First-time contributors { #first-time-contributors }

{% extends "contribute/first-time-contributors.md" %}
{% extends "_shared/contribute/first-time-contributors.md" %}
2 changes: 1 addition & 1 deletion docs/en/contributing/guide/how/branches.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Work from a feature branch, not your `main` branch

{% extends "contribute/how/branches.md" %}
{% extends "_shared/contribute/how/branches.md" %}
6 changes: 3 additions & 3 deletions docs/en/contributing/guide/how/build-docs.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
# Building documentation

{% extends "contribute/how/build-docs.md" %}
{% extends "_shared/contribute/how/build-docs.md" %}

{% block front_matter %}

Before you build the documentation, and have a [development environment](dev-environment.md) set up.
Before you build the documentation, and have a [development environment](../how/dev-environment.md) set up.

{% endblock %}

{% block end_matter %}

Once you have successfully built the docs, you are ready to [write documentation](write-docs.md).
Once you have successfully built the docs, you are ready to [write documentation](../how/write-docs.md).

{% endblock %}
2 changes: 1 addition & 1 deletion docs/en/contributing/guide/how/change-note.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Adding change information for release notes

{% extends "contribute/how/change-note.md" %}
{% extends "_shared/contribute/how/change-note.md" %}
8 changes: 7 additions & 1 deletion docs/en/contributing/guide/how/dev-environment.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
# Setting up a development environment

{% extends "contribute/how/dev-environment.md" %}
The steps for setting up a development environment vary depending on the project you're contributing to. Choose from the following:

* [Briefcase](https://briefcase.beeware.org/en/stable/how-to/contribute/how/dev-environment/)
* [Toga](https://toga.beeware.org/en/stable/how-to/contribute/how/dev-environment/)
* [Rubicon Objective-C](https://rubicon-objc.beeware.org/en/stable/how-to/contribute/how/dev-environment/)
Comment thread
freakboy3742 marked this conversation as resolved.

If the repository you want to contribute to isn't on this list, follow the development guide for the most relevant project. For example, if you want to work on a Briefcase template repository, you should follow the guide for Briefcase.
2 changes: 1 addition & 1 deletion docs/en/contributing/guide/how/new-issue.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Submitting a new issue

{% extends "contribute/how/new-issue.md" %}
{% extends "_shared/contribute/how/new-issue.md" %}
2 changes: 1 addition & 1 deletion docs/en/contributing/guide/how/propose-feature.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Proposing a new feature

{% extends "contribute/how/propose-feature.md" %}
{% extends "_shared/contribute/how/propose-feature.md" %}

{% block end_matter %}

Expand Down
4 changes: 2 additions & 2 deletions docs/en/contributing/guide/how/reproduce-issue.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Reproducing an issue

{% extends "contribute/how/reproduce-issue.md" %}
{% extends "_shared/contribute/how/reproduce-issue.md" %}

{% block front_matter %}

To begin reproducing an issue, you will need a [development environment](dev-environment.md) set up.
To begin reproducing an issue, you will need a [development environment](../how/dev-environment.md) set up.

{% endblock %}

Expand Down
2 changes: 1 addition & 1 deletion docs/en/contributing/guide/how/review-pr.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Providing a pull request review

{% extends "contribute/how/review-pr.md" %}
{% extends "_shared/contribute/how/review-pr.md" %}
2 changes: 1 addition & 1 deletion docs/en/contributing/guide/how/scope-creep.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Avoiding scope creep

{% extends "contribute/how/scope-creep.md" %}
{% extends "_shared/contribute/how/scope-creep.md" %}
6 changes: 3 additions & 3 deletions docs/en/contributing/guide/how/submit-pr.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
# Submitting a pull request

{% extends "contribute/how/submit-pr.md" %}
{% extends "_shared/contribute/how/submit-pr.md" %}

{% block end_matter %}

{% if config.extra.website %}

Your pull request may require additional content, such as a [change note](change-note.md), before it can be [reviewed](../next/pr-review.md).
Your pull request may require additional content, such as a [change note](../how/change-note.md), before it can be [reviewed](../next/pr-review.md).

{% else %}

As part of submitting a pull request, you'll need to include a [change note](change-note.md) before it can be [reviewed](../next/pr-review.md).
As part of submitting a pull request, you'll need to include a [change note](../how/change-note.md) before it can be [reviewed](../next/pr-review.md).

{% endif %}

Expand Down
2 changes: 1 addition & 1 deletion docs/en/contributing/guide/how/translate.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Translating content

{% extends "contribute/how/translate.md" %}
{% extends "_shared/contribute/how/translate.md" %}
6 changes: 3 additions & 3 deletions docs/en/contributing/guide/how/write-code.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
# Writing, running, and testing code

{% extends "contribute/how/write-code.md" %}
{% extends "_shared/contribute/how/write-code.md" %}

{% block front_matter %}

To begin working on code, ensure you have a [development environment](dev-environment.md) set up, and you are [working on a branch](branches.md)
To begin working on code, ensure you have a [development environment](../how/dev-environment.md) set up, and you are [working on a branch](../how/branches.md)

{% endblock %}

{% block end_matter %}

Once you have everything working, you can [submit a pull request](submit-pr.md) with your changes.
Once you have everything working, you can [submit a pull request](../how/submit-pr.md) with your changes.

{% endblock %}
6 changes: 3 additions & 3 deletions docs/en/contributing/guide/how/write-docs.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
# Writing documentation

{% extends "contribute/how/write-docs.md" %}
{% extends "_shared/contribute/how/write-docs.md" %}

{% block front_matter %}

Before you begin writing documentation, ensure you are able to [build the documentation](build-docs.md), and you are [working on a branch](branches.md).
Before you begin writing documentation, ensure you are able to [build the documentation](../how/build-docs.md), and you are [working on a branch](../how/branches.md).

{% endblock %}

{% block end_matter %}

Once you are happy with your new documentation, you can [submit a pull request](submit-pr.md) with your proposed changes.
Once you are happy with your new documentation, you can [submit a pull request](../how/submit-pr.md) with your proposed changes.

{% endblock %}
2 changes: 1 addition & 1 deletion docs/en/contributing/guide/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Contribution guide

{% extends "contribute/index.md" %}
{% extends "_shared/contribute/index.md" %}
2 changes: 1 addition & 1 deletion docs/en/contributing/guide/next/pr-review.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Receiving a pull request review

{% extends "contribute/next/pr-review.md" %}
{% extends "_shared/contribute/next/pr-review.md" %}
2 changes: 1 addition & 1 deletion docs/en/contributing/guide/next/release.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# The release process

{% extends "contribute/next/release.md" %}
{% extends "_shared/contribute/next/release.md" %}
2 changes: 1 addition & 1 deletion docs/en/contributing/guide/policies/ai-policy.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
<!-- rumdl-disable-file MD041 -->

{% extends "contribute/policies/ai-policy.md" %}
{% extends "_shared/contribute/policies/ai-policy.md" %}
2 changes: 1 addition & 1 deletion docs/en/contributing/guide/style/code-style-guide.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Code style guide

{% extends "contribute/style/code-style-guide.md" %}
{% extends "_shared/contribute/style/code-style-guide.md" %}
2 changes: 1 addition & 1 deletion docs/en/contributing/guide/style/docs-style-guide.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Documentation style guide

{% extends "contribute/style/docs-style-guide.md" %}
{% extends "_shared/contribute/style/docs-style-guide.md" %}
2 changes: 1 addition & 1 deletion docs/en/contributing/guide/what/fix-issue.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Fixing an issue

{% extends "contribute/what/fix-issue.md" %}
{% extends "_shared/contribute/what/fix-issue.md" %}
2 changes: 1 addition & 1 deletion docs/en/contributing/guide/what/implement-feature.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Implementing a new feature

{% extends "contribute/what/implement-feature.md" %}
{% extends "_shared/contribute/what/implement-feature.md" %}
2 changes: 1 addition & 1 deletion docs/en/contributing/guide/what/propose-feature.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Proposing a new feature

{% extends "contribute/what/propose-feature.md" %}
{% extends "_shared/contribute/what/propose-feature.md" %}
2 changes: 1 addition & 1 deletion docs/en/contributing/guide/what/review-pr.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Providing a pull request review

{% extends "contribute/what/review-pr.md" %}
{% extends "_shared/contribute/what/review-pr.md" %}
2 changes: 1 addition & 1 deletion docs/en/contributing/guide/what/translate.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Translating content

{% extends "contribute/what/translate.md" %}
{% extends "_shared/contribute/what/translate.md" %}
2 changes: 1 addition & 1 deletion docs/en/contributing/guide/what/triage.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Triaging an issue

{% extends "contribute/what/triage.md" %}
{% extends "_shared/contribute/what/triage.md" %}
2 changes: 1 addition & 1 deletion docs/en/contributing/guide/what/use-tools.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Using the tools

{% extends "contribute/what/use-tools.md" %}
{% extends "_shared/contribute/what/use-tools.md" %}
2 changes: 1 addition & 1 deletion docs/en/contributing/guide/what/write-docs.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Adding documentation

{% extends "contribute/what/write-docs.md" %}
{% extends "_shared/contribute/what/write-docs.md" %}