From 7647dd743f4bc56175ec58730b92aca655d2c913 Mon Sep 17 00:00:00 2001 From: Kattni Date: Tue, 2 Jun 2026 00:40:42 -0400 Subject: [PATCH 1/5] Include multiple directories for macros. --- docs/en/SUMMARY.md | 72 +++++++++---------- .../contribute/first-time-contributors.md | 0 .../how-to/contribute/how/branches.md | 0 .../how-to/contribute/how/build-docs.md | 0 .../how-to/contribute/how/change-note.md | 0 .../how-to/contribute/how/dev-environment.md | 0 .../how-to/contribute/how/new-issue.md | 0 .../how-to/contribute/how/propose-feature.md | 0 .../how-to/contribute/how/reproduce-issue.md | 0 .../how-to/contribute/how/review-pr.md | 0 .../how-to/contribute/how/scope-creep.md | 0 .../how-to/contribute/how/submit-pr.md | 0 .../how-to/contribute/how/translate.md | 0 .../how-to/contribute/how/write-code.md | 0 .../how-to/contribute/how/write-docs.md | 0 .../how-to/contribute/index.md | 0 .../how-to/contribute/next/pr-review.md | 0 .../how-to/contribute/next/release.md | 0 .../how-to/contribute/policies/ai-policy.md | 0 .../contribute/style/code-style-guide.md | 0 .../contribute/style/docs-style-guide.md | 0 .../how-to/contribute/what/fix-issue.md | 0 .../contribute/what/implement-feature.md | 0 .../how-to/contribute/what/propose-feature.md | 0 .../how-to/contribute/what/review-pr.md | 0 .../how-to/contribute/what/translate.md | 0 .../how-to/contribute/what/triage.md | 0 .../how-to/contribute/what/use-tools.md | 0 .../how-to/contribute/what/write-docs.md | 0 docs/en/{content_test_bed => how-to}/index.md | 0 pyproject.toml | 5 +- src/beeware_docs_tools/live_serve_en.py | 2 +- src/beeware_docs_tools/md_tempdir.py | 9 ++- .../en/contribute/what/fix-issue.md | 2 +- 34 files changed, 48 insertions(+), 42 deletions(-) rename docs/en/{content_test_bed => }/how-to/contribute/first-time-contributors.md (100%) rename docs/en/{content_test_bed => }/how-to/contribute/how/branches.md (100%) rename docs/en/{content_test_bed => }/how-to/contribute/how/build-docs.md (100%) rename docs/en/{content_test_bed => }/how-to/contribute/how/change-note.md (100%) rename docs/en/{content_test_bed => }/how-to/contribute/how/dev-environment.md (100%) rename docs/en/{content_test_bed => }/how-to/contribute/how/new-issue.md (100%) rename docs/en/{content_test_bed => }/how-to/contribute/how/propose-feature.md (100%) rename docs/en/{content_test_bed => }/how-to/contribute/how/reproduce-issue.md (100%) rename docs/en/{content_test_bed => }/how-to/contribute/how/review-pr.md (100%) rename docs/en/{content_test_bed => }/how-to/contribute/how/scope-creep.md (100%) rename docs/en/{content_test_bed => }/how-to/contribute/how/submit-pr.md (100%) rename docs/en/{content_test_bed => }/how-to/contribute/how/translate.md (100%) rename docs/en/{content_test_bed => }/how-to/contribute/how/write-code.md (100%) rename docs/en/{content_test_bed => }/how-to/contribute/how/write-docs.md (100%) rename docs/en/{content_test_bed => }/how-to/contribute/index.md (100%) rename docs/en/{content_test_bed => }/how-to/contribute/next/pr-review.md (100%) rename docs/en/{content_test_bed => }/how-to/contribute/next/release.md (100%) rename docs/en/{content_test_bed => }/how-to/contribute/policies/ai-policy.md (100%) rename docs/en/{content_test_bed => }/how-to/contribute/style/code-style-guide.md (100%) rename docs/en/{content_test_bed => }/how-to/contribute/style/docs-style-guide.md (100%) rename docs/en/{content_test_bed => }/how-to/contribute/what/fix-issue.md (100%) rename docs/en/{content_test_bed => }/how-to/contribute/what/implement-feature.md (100%) rename docs/en/{content_test_bed => }/how-to/contribute/what/propose-feature.md (100%) rename docs/en/{content_test_bed => }/how-to/contribute/what/review-pr.md (100%) rename docs/en/{content_test_bed => }/how-to/contribute/what/translate.md (100%) rename docs/en/{content_test_bed => }/how-to/contribute/what/triage.md (100%) rename docs/en/{content_test_bed => }/how-to/contribute/what/use-tools.md (100%) rename docs/en/{content_test_bed => }/how-to/contribute/what/write-docs.md (100%) rename docs/en/{content_test_bed => how-to}/index.md (100%) diff --git a/docs/en/SUMMARY.md b/docs/en/SUMMARY.md index 21ed34eb..7ef01873 100644 --- a/docs/en/SUMMARY.md +++ b/docs/en/SUMMARY.md @@ -9,40 +9,38 @@ search: - [Section two](section_two/index.md) - [Section three](section_three/index.md) - ./section_three/* -- Shared content testbed - - [Shared content testbed](content_test_bed/index.md) - - How-to guides - - Contribute - - [Contributing](content_test_bed/how-to/contribute/index.md) - - [First-time contributors](content_test_bed/how-to/contribute/first-time-contributors.md) - - What can I do? - - [Fix an issue](content_test_bed/how-to/contribute/what/fix-issue.md) - - [Implement a new feature](content_test_bed/how-to/contribute/what/implement-feature.md) - - [Write documentation](content_test_bed/how-to/contribute/what/write-docs.md) - - [Triage an issue](content_test_bed/how-to/contribute/what/triage.md) - - [Review a pull request](content_test_bed/how-to/contribute/what/review-pr.md) - - [Propose a new feature](content_test_bed/how-to/contribute/what/propose-feature.md) - - [Translate content](content_test_bed/how-to/contribute/what/translate.md) - - [Use the tools](content_test_bed/how-to/contribute/what/use-tools.md) - - How do I contribute? - - [Setting up a development environment](content_test_bed/how-to/contribute/how/dev-environment.md) - - [Reproducing an issue](content_test_bed/how-to/contribute/how/reproduce-issue.md) - - [Working from a branch](content_test_bed/how-to/contribute/how/branches.md) - - [Avoiding scope creep](content_test_bed/how-to/contribute/how/scope-creep.md) - - [Writing, running, and testing code](content_test_bed/how-to/contribute/how/write-code.md) - - [Building documentation](content_test_bed/how-to/contribute/how/build-docs.md) - - [Writing documentation](content_test_bed/how-to/contribute/how/write-docs.md) - - [Adding a change note](content_test_bed/how-to/contribute/how/change-note.md) - - [Submitting a pull request](content_test_bed/how-to/contribute/how/submit-pr.md) - - [Providing a review](content_test_bed/how-to/contribute/how/review-pr.md) - - [Submitting a new issue](content_test_bed/how-to/contribute/how/new-issue.md) - - [Proposing a new feature](content_test_bed/how-to/contribute/how/propose-feature.md) - - [Translating content](content_test_bed/how-to/contribute/how/translate.md) - - What happens next? - - [Pull request review process](content_test_bed/how-to/contribute/next/pr-review.md) - - [Release process](content_test_bed/how-to/contribute/next/release.md) - - Policies - - [AI Policy](content_test_bed/how-to/contribute/policies/ai-policy.md) - - Style guides - - [Code style guide](content_test_bed/how-to/contribute/style/code-style-guide.md) - - [Documentation style guide](content_test_bed/how-to/contribute/style/docs-style-guide.md) +- [How-to guides](how-to/index.md) + - Contribute + - [Contributing](how-to/contribute/index.md) + - [First-time contributors](how-to/contribute/first-time-contributors.md) + - What can I do? + - [Fix an issue](how-to/contribute/what/fix-issue.md) + - [Implement a new feature](how-to/contribute/what/implement-feature.md) + - [Write documentation](how-to/contribute/what/write-docs.md) + - [Triage an issue](how-to/contribute/what/triage.md) + - [Review a pull request](how-to/contribute/what/review-pr.md) + - [Propose a new feature](how-to/contribute/what/propose-feature.md) + - [Translate content](how-to/contribute/what/translate.md) + - [Use the tools](how-to/contribute/what/use-tools.md) + - How do I contribute? + - [Setting up a development environment](how-to/contribute/how/dev-environment.md) + - [Reproducing an issue](how-to/contribute/how/reproduce-issue.md) + - [Working from a branch](how-to/contribute/how/branches.md) + - [Avoiding scope creep](how-to/contribute/how/scope-creep.md) + - [Writing, running, and testing code](how-to/contribute/how/write-code.md) + - [Building documentation](how-to/contribute/how/build-docs.md) + - [Writing documentation](how-to/contribute/how/write-docs.md) + - [Adding a change note](how-to/contribute/how/change-note.md) + - [Submitting a pull request](how-to/contribute/how/submit-pr.md) + - [Providing a review](how-to/contribute/how/review-pr.md) + - [Submitting a new issue](how-to/contribute/how/new-issue.md) + - [Proposing a new feature](how-to/contribute/how/propose-feature.md) + - [Translating content](how-to/contribute/how/translate.md) + - What happens next? + - [Pull request review process](how-to/contribute/next/pr-review.md) + - [Release process](how-to/contribute/next/release.md) + - Policies + - [AI Policy](how-to/contribute/policies/ai-policy.md) + - Style guides + - [Code style guide](how-to/contribute/style/code-style-guide.md) + - [Documentation style guide](how-to/contribute/style/docs-style-guide.md) diff --git a/docs/en/content_test_bed/how-to/contribute/first-time-contributors.md b/docs/en/how-to/contribute/first-time-contributors.md similarity index 100% rename from docs/en/content_test_bed/how-to/contribute/first-time-contributors.md rename to docs/en/how-to/contribute/first-time-contributors.md diff --git a/docs/en/content_test_bed/how-to/contribute/how/branches.md b/docs/en/how-to/contribute/how/branches.md similarity index 100% rename from docs/en/content_test_bed/how-to/contribute/how/branches.md rename to docs/en/how-to/contribute/how/branches.md diff --git a/docs/en/content_test_bed/how-to/contribute/how/build-docs.md b/docs/en/how-to/contribute/how/build-docs.md similarity index 100% rename from docs/en/content_test_bed/how-to/contribute/how/build-docs.md rename to docs/en/how-to/contribute/how/build-docs.md diff --git a/docs/en/content_test_bed/how-to/contribute/how/change-note.md b/docs/en/how-to/contribute/how/change-note.md similarity index 100% rename from docs/en/content_test_bed/how-to/contribute/how/change-note.md rename to docs/en/how-to/contribute/how/change-note.md diff --git a/docs/en/content_test_bed/how-to/contribute/how/dev-environment.md b/docs/en/how-to/contribute/how/dev-environment.md similarity index 100% rename from docs/en/content_test_bed/how-to/contribute/how/dev-environment.md rename to docs/en/how-to/contribute/how/dev-environment.md diff --git a/docs/en/content_test_bed/how-to/contribute/how/new-issue.md b/docs/en/how-to/contribute/how/new-issue.md similarity index 100% rename from docs/en/content_test_bed/how-to/contribute/how/new-issue.md rename to docs/en/how-to/contribute/how/new-issue.md diff --git a/docs/en/content_test_bed/how-to/contribute/how/propose-feature.md b/docs/en/how-to/contribute/how/propose-feature.md similarity index 100% rename from docs/en/content_test_bed/how-to/contribute/how/propose-feature.md rename to docs/en/how-to/contribute/how/propose-feature.md diff --git a/docs/en/content_test_bed/how-to/contribute/how/reproduce-issue.md b/docs/en/how-to/contribute/how/reproduce-issue.md similarity index 100% rename from docs/en/content_test_bed/how-to/contribute/how/reproduce-issue.md rename to docs/en/how-to/contribute/how/reproduce-issue.md diff --git a/docs/en/content_test_bed/how-to/contribute/how/review-pr.md b/docs/en/how-to/contribute/how/review-pr.md similarity index 100% rename from docs/en/content_test_bed/how-to/contribute/how/review-pr.md rename to docs/en/how-to/contribute/how/review-pr.md diff --git a/docs/en/content_test_bed/how-to/contribute/how/scope-creep.md b/docs/en/how-to/contribute/how/scope-creep.md similarity index 100% rename from docs/en/content_test_bed/how-to/contribute/how/scope-creep.md rename to docs/en/how-to/contribute/how/scope-creep.md diff --git a/docs/en/content_test_bed/how-to/contribute/how/submit-pr.md b/docs/en/how-to/contribute/how/submit-pr.md similarity index 100% rename from docs/en/content_test_bed/how-to/contribute/how/submit-pr.md rename to docs/en/how-to/contribute/how/submit-pr.md diff --git a/docs/en/content_test_bed/how-to/contribute/how/translate.md b/docs/en/how-to/contribute/how/translate.md similarity index 100% rename from docs/en/content_test_bed/how-to/contribute/how/translate.md rename to docs/en/how-to/contribute/how/translate.md diff --git a/docs/en/content_test_bed/how-to/contribute/how/write-code.md b/docs/en/how-to/contribute/how/write-code.md similarity index 100% rename from docs/en/content_test_bed/how-to/contribute/how/write-code.md rename to docs/en/how-to/contribute/how/write-code.md diff --git a/docs/en/content_test_bed/how-to/contribute/how/write-docs.md b/docs/en/how-to/contribute/how/write-docs.md similarity index 100% rename from docs/en/content_test_bed/how-to/contribute/how/write-docs.md rename to docs/en/how-to/contribute/how/write-docs.md diff --git a/docs/en/content_test_bed/how-to/contribute/index.md b/docs/en/how-to/contribute/index.md similarity index 100% rename from docs/en/content_test_bed/how-to/contribute/index.md rename to docs/en/how-to/contribute/index.md diff --git a/docs/en/content_test_bed/how-to/contribute/next/pr-review.md b/docs/en/how-to/contribute/next/pr-review.md similarity index 100% rename from docs/en/content_test_bed/how-to/contribute/next/pr-review.md rename to docs/en/how-to/contribute/next/pr-review.md diff --git a/docs/en/content_test_bed/how-to/contribute/next/release.md b/docs/en/how-to/contribute/next/release.md similarity index 100% rename from docs/en/content_test_bed/how-to/contribute/next/release.md rename to docs/en/how-to/contribute/next/release.md diff --git a/docs/en/content_test_bed/how-to/contribute/policies/ai-policy.md b/docs/en/how-to/contribute/policies/ai-policy.md similarity index 100% rename from docs/en/content_test_bed/how-to/contribute/policies/ai-policy.md rename to docs/en/how-to/contribute/policies/ai-policy.md diff --git a/docs/en/content_test_bed/how-to/contribute/style/code-style-guide.md b/docs/en/how-to/contribute/style/code-style-guide.md similarity index 100% rename from docs/en/content_test_bed/how-to/contribute/style/code-style-guide.md rename to docs/en/how-to/contribute/style/code-style-guide.md diff --git a/docs/en/content_test_bed/how-to/contribute/style/docs-style-guide.md b/docs/en/how-to/contribute/style/docs-style-guide.md similarity index 100% rename from docs/en/content_test_bed/how-to/contribute/style/docs-style-guide.md rename to docs/en/how-to/contribute/style/docs-style-guide.md diff --git a/docs/en/content_test_bed/how-to/contribute/what/fix-issue.md b/docs/en/how-to/contribute/what/fix-issue.md similarity index 100% rename from docs/en/content_test_bed/how-to/contribute/what/fix-issue.md rename to docs/en/how-to/contribute/what/fix-issue.md diff --git a/docs/en/content_test_bed/how-to/contribute/what/implement-feature.md b/docs/en/how-to/contribute/what/implement-feature.md similarity index 100% rename from docs/en/content_test_bed/how-to/contribute/what/implement-feature.md rename to docs/en/how-to/contribute/what/implement-feature.md diff --git a/docs/en/content_test_bed/how-to/contribute/what/propose-feature.md b/docs/en/how-to/contribute/what/propose-feature.md similarity index 100% rename from docs/en/content_test_bed/how-to/contribute/what/propose-feature.md rename to docs/en/how-to/contribute/what/propose-feature.md diff --git a/docs/en/content_test_bed/how-to/contribute/what/review-pr.md b/docs/en/how-to/contribute/what/review-pr.md similarity index 100% rename from docs/en/content_test_bed/how-to/contribute/what/review-pr.md rename to docs/en/how-to/contribute/what/review-pr.md diff --git a/docs/en/content_test_bed/how-to/contribute/what/translate.md b/docs/en/how-to/contribute/what/translate.md similarity index 100% rename from docs/en/content_test_bed/how-to/contribute/what/translate.md rename to docs/en/how-to/contribute/what/translate.md diff --git a/docs/en/content_test_bed/how-to/contribute/what/triage.md b/docs/en/how-to/contribute/what/triage.md similarity index 100% rename from docs/en/content_test_bed/how-to/contribute/what/triage.md rename to docs/en/how-to/contribute/what/triage.md diff --git a/docs/en/content_test_bed/how-to/contribute/what/use-tools.md b/docs/en/how-to/contribute/what/use-tools.md similarity index 100% rename from docs/en/content_test_bed/how-to/contribute/what/use-tools.md rename to docs/en/how-to/contribute/what/use-tools.md diff --git a/docs/en/content_test_bed/how-to/contribute/what/write-docs.md b/docs/en/how-to/contribute/what/write-docs.md similarity index 100% rename from docs/en/content_test_bed/how-to/contribute/what/write-docs.md rename to docs/en/how-to/contribute/what/write-docs.md diff --git a/docs/en/content_test_bed/index.md b/docs/en/how-to/index.md similarity index 100% rename from docs/en/content_test_bed/index.md rename to docs/en/how-to/index.md diff --git a/pyproject.toml b/pyproject.toml index 4920c65d..1b6f1c3f 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -23,13 +23,14 @@ maintainers = [ ] dependencies = [ - "click==8.3.3", + "click==8.4.0", "deepl==1.30.0", "markdown-checker==1.0.2", "mistletoe==1.5.1", "mkdocs-autorefs==1.4.4", "mkdocs-literate-nav==0.6.3", # DO NOT UPGRADE - Uncertain whether author's move to ProperDocs will cause incompatibility - "mkdocs-macros-plugin==1.5.0", + "mkdocs-macros-plugin @ file:///Users/kattni/BeeWare/mkdocs-macros-plugin", +# "mkdocs-macros-plugin", "mkdocs-material==9.7.6", "mkdocs-rss-plugin==1.19.0", "mkdocs==1.6.1", # DO NOT UPGRADE - 2+ is not compatible with anything here diff --git a/src/beeware_docs_tools/live_serve_en.py b/src/beeware_docs_tools/live_serve_en.py index f7c0cbc5..7fec9abf 100644 --- a/src/beeware_docs_tools/live_serve_en.py +++ b/src/beeware_docs_tools/live_serve_en.py @@ -66,7 +66,7 @@ def serve_docs( "mkdocs", "serve", "--clean", - "--livereload", + # "--livereload", "--config-file", str(output_path / "mkdocs.en.yml"), "--watch", diff --git a/src/beeware_docs_tools/md_tempdir.py b/src/beeware_docs_tools/md_tempdir.py index 38f3348d..c777d38b 100644 --- a/src/beeware_docs_tools/md_tempdir.py +++ b/src/beeware_docs_tools/md_tempdir.py @@ -70,12 +70,19 @@ def save_config(project_path, temp_md_path, config, language="en"): if language != "en": shared_content_path = temp_md_path.resolve() / f"shared_content/{language}" + local_docs_path = temp_md_path.resolve() / f"docs/{language}" else: shared_content_path = (Path(__file__).parent / "shared_content/en").resolve() + local_docs_path = (project_path / "docs/en").resolve() base_path.append(str(shared_content_path)) config["markdown_extensions"]["pymdownx.snippets"]["base_path"] = base_path - config["plugins"]["macros"]["include_dir"] = str(shared_content_path) + print(config["plugins"]["macros"]["include_dir"]) + config["plugins"]["macros"]["include_dir"] = [ + str(shared_content_path), + str(local_docs_path), + ] + print(config["plugins"]["macros"]["include_dir"]) with (temp_md_path / "config.yml").open("w", encoding="utf-8") as config_f: yaml.dump(config, config_f) diff --git a/src/beeware_docs_tools/shared_content/en/contribute/what/fix-issue.md b/src/beeware_docs_tools/shared_content/en/contribute/what/fix-issue.md index f76afb66..d56c6d5a 100644 --- a/src/beeware_docs_tools/shared_content/en/contribute/what/fix-issue.md +++ b/src/beeware_docs_tools/shared_content/en/contribute/what/fix-issue.md @@ -12,7 +12,7 @@ Even if you can't fix the problem, reporting anything you discover during the pr /// details-abstract | Set up a development environment -{% include "contribute/how/dev-environment.md" %} +{% include "how-to/contribute/how/dev-environment.md" %} /// From cdb7942ade1aa0613ba0b3341655c654a7793a23 Mon Sep 17 00:00:00 2001 From: Kattni Date: Tue, 2 Jun 2026 21:48:40 -0400 Subject: [PATCH 2/5] Resolve relative path issues, update tooling. --- docs/en/how-to/contribute/how/build-docs.md | 4 ++-- docs/en/how-to/contribute/how/reproduce-issue.md | 2 +- docs/en/how-to/contribute/how/submit-pr.md | 4 ++-- docs/en/how-to/contribute/how/write-code.md | 4 ++-- docs/en/how-to/contribute/how/write-docs.md | 4 ++-- pyproject.toml | 3 +-- src/beeware_docs_tools/live_serve_en.py | 1 - src/beeware_docs_tools/md_tempdir.py | 4 +--- .../en/contribute/what/fix-issue.md | 14 +++++++------- .../en/contribute/what/implement-feature.md | 16 ++++++++-------- .../en/contribute/what/propose-feature.md | 2 +- .../en/contribute/what/review-pr.md | 2 +- .../en/contribute/what/translate.md | 2 +- .../shared_content/en/contribute/what/triage.md | 2 +- .../en/contribute/what/use-tools.md | 4 ++-- .../en/contribute/what/write-docs.md | 16 ++++++++-------- 16 files changed, 40 insertions(+), 44 deletions(-) diff --git a/docs/en/how-to/contribute/how/build-docs.md b/docs/en/how-to/contribute/how/build-docs.md index 3c5f6f36..3e6936d6 100644 --- a/docs/en/how-to/contribute/how/build-docs.md +++ b/docs/en/how-to/contribute/how/build-docs.md @@ -4,12 +4,12 @@ {% 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 %} diff --git a/docs/en/how-to/contribute/how/reproduce-issue.md b/docs/en/how-to/contribute/how/reproduce-issue.md index 319dbb6a..3bddd945 100644 --- a/docs/en/how-to/contribute/how/reproduce-issue.md +++ b/docs/en/how-to/contribute/how/reproduce-issue.md @@ -4,7 +4,7 @@ {% 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 %} diff --git a/docs/en/how-to/contribute/how/submit-pr.md b/docs/en/how-to/contribute/how/submit-pr.md index 6f92de86..6e71a9b1 100644 --- a/docs/en/how-to/contribute/how/submit-pr.md +++ b/docs/en/how-to/contribute/how/submit-pr.md @@ -6,11 +6,11 @@ {% 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 %} diff --git a/docs/en/how-to/contribute/how/write-code.md b/docs/en/how-to/contribute/how/write-code.md index bd585753..aede2e0a 100644 --- a/docs/en/how-to/contribute/how/write-code.md +++ b/docs/en/how-to/contribute/how/write-code.md @@ -4,12 +4,12 @@ {% 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 %} diff --git a/docs/en/how-to/contribute/how/write-docs.md b/docs/en/how-to/contribute/how/write-docs.md index c3d86ec0..dc4862f3 100644 --- a/docs/en/how-to/contribute/how/write-docs.md +++ b/docs/en/how-to/contribute/how/write-docs.md @@ -4,12 +4,12 @@ {% 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 %} diff --git a/pyproject.toml b/pyproject.toml index 047ceb03..2b697c5f 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -29,8 +29,7 @@ dependencies = [ "mistletoe==1.5.1", "mkdocs-autorefs==1.4.4", "mkdocs-literate-nav==0.6.3", # DO NOT UPGRADE - Uncertain whether author's move to ProperDocs will cause incompatibility - "mkdocs-macros-plugin @ file:///Users/kattni/BeeWare/mkdocs-macros-plugin", -# "mkdocs-macros-plugin", + "mkdocs-macros-plugin @ git+https://github.com/kattni/mkdocs-macros-plugin@include-dir-multiple-directories", "mkdocs-material==9.7.6", "mkdocs-rss-plugin==1.19.0", "mkdocs==1.6.1", # DO NOT UPGRADE - 2+ is not compatible with anything here diff --git a/src/beeware_docs_tools/live_serve_en.py b/src/beeware_docs_tools/live_serve_en.py index 7fec9abf..a99d4712 100644 --- a/src/beeware_docs_tools/live_serve_en.py +++ b/src/beeware_docs_tools/live_serve_en.py @@ -66,7 +66,6 @@ def serve_docs( "mkdocs", "serve", "--clean", - # "--livereload", "--config-file", str(output_path / "mkdocs.en.yml"), "--watch", diff --git a/src/beeware_docs_tools/md_tempdir.py b/src/beeware_docs_tools/md_tempdir.py index 5cc69e73..4ed77b79 100644 --- a/src/beeware_docs_tools/md_tempdir.py +++ b/src/beeware_docs_tools/md_tempdir.py @@ -70,19 +70,17 @@ def save_config(project_path, temp_md_path, config, language="en"): if language != "en": shared_content_path = temp_md_path.resolve() / f"shared_content/{language}" - local_docs_path = temp_md_path.resolve() / f"docs/{language}" + local_docs_path = temp_md_path.resolve() / f"{language}" else: shared_content_path = (Path(__file__).parent / "shared_content/en").resolve() local_docs_path = (project_path / "docs/en").resolve() base_path.append(str(shared_content_path)) config["markdown_extensions"]["pymdownx.snippets"]["base_path"] = base_path - print(config["plugins"]["macros"]["include_dir"]) config["plugins"]["macros"]["include_dir"] = [ str(shared_content_path), str(local_docs_path), ] - print(config["plugins"]["macros"]["include_dir"]) with (temp_md_path / "config.yml").open("w", encoding="utf-8") as config_f: yaml.dump(config, config_f) diff --git a/src/beeware_docs_tools/shared_content/en/contribute/what/fix-issue.md b/src/beeware_docs_tools/shared_content/en/contribute/what/fix-issue.md index d56c6d5a..108fad9b 100644 --- a/src/beeware_docs_tools/shared_content/en/contribute/what/fix-issue.md +++ b/src/beeware_docs_tools/shared_content/en/contribute/what/fix-issue.md @@ -18,13 +18,13 @@ Even if you can't fix the problem, reporting anything you discover during the pr /// details-abstract | Work from a branch -{% include "contribute/how/branches.md" %} +{% include "how-to/contribute/how/branches.md" %} /// /// details-abstract | Reproduce the issue -{% include "contribute/how/reproduce-issue.md" %} +{% include "how-to/contribute/how/reproduce-issue.md" %} /// @@ -32,7 +32,7 @@ Even if you can't fix the problem, reporting anything you discover during the pr /// details-abstract | Write, run, and test code -{% include "contribute/how/write-code.md" %} +{% include "how-to/contribute/how/write-code.md" %} /// @@ -40,13 +40,13 @@ Even if you can't fix the problem, reporting anything you discover during the pr /// details-abstract | Build documentation -{% include "contribute/how/build-docs.md" %} +{% include "how-to/contribute/how/build-docs.md" %} /// /// details-abstract | Write documentation -{% include "contribute/how/write-docs.md" %} +{% include "how-to/contribute/how/write-docs.md" %} /// @@ -54,12 +54,12 @@ Even if you can't fix the problem, reporting anything you discover during the pr /// details-abstract | Add a change note -{% include "contribute/how/change-note.md" %} +{% include "how-to/contribute/how/change-note.md" %} /// /// details-abstract | Submit a pull request -{% include "contribute/how/submit-pr.md" %} +{% include "how-to/contribute/how/submit-pr.md" %} /// diff --git a/src/beeware_docs_tools/shared_content/en/contribute/what/implement-feature.md b/src/beeware_docs_tools/shared_content/en/contribute/what/implement-feature.md index c8035690..a18982b1 100644 --- a/src/beeware_docs_tools/shared_content/en/contribute/what/implement-feature.md +++ b/src/beeware_docs_tools/shared_content/en/contribute/what/implement-feature.md @@ -15,48 +15,48 @@ An important part of implementing a new feature is ensuring that feature is full /// details-abstract | Set up a development environment -{% include "contribute/how/dev-environment.md" %} +{% include "how-to/contribute/how/dev-environment.md" %} /// /// details-abstract | Work from a branch -{% include "contribute/how/branches.md" %} +{% include "how-to/contribute/how/branches.md" %} /// /// details-abstract | Avoid scope creep -{% include "contribute/how/scope-creep.md" %} +{% include "how-to/contribute/how/scope-creep.md" %} /// /// details-abstract | Implement the new feature -{% include "contribute/how/write-code.md" %} +{% include "how-to/contribute/how/write-code.md" %} /// /// details-abstract | Build documentation -{% include "contribute/how/build-docs.md" %} +{% include "how-to/contribute/how/build-docs.md" %} /// /// details-abstract | Write documentation -{% include "contribute/how/write-docs.md" %} +{% include "how-to/contribute/how/write-docs.md" %} /// /// details-abstract | Add a change note -{% include "contribute/how/change-note.md" %} +{% include "how-to/contribute/how/change-note.md" %} /// /// details-abstract | Submit a pull request -{% include "contribute/how/submit-pr.md" %} +{% include "how-to/contribute/how/submit-pr.md" %} /// diff --git a/src/beeware_docs_tools/shared_content/en/contribute/what/propose-feature.md b/src/beeware_docs_tools/shared_content/en/contribute/what/propose-feature.md index 957d1831..d82a76f0 100644 --- a/src/beeware_docs_tools/shared_content/en/contribute/what/propose-feature.md +++ b/src/beeware_docs_tools/shared_content/en/contribute/what/propose-feature.md @@ -38,6 +38,6 @@ If you're unsure about any of this, don't worry! Submit your idea, and let us kn /// details-abstract | Proposing a new feature -{% include "contribute/how/propose-feature.md" %} +{% include "how-to/contribute/how/propose-feature.md" %} /// diff --git a/src/beeware_docs_tools/shared_content/en/contribute/what/review-pr.md b/src/beeware_docs_tools/shared_content/en/contribute/what/review-pr.md index 0bd7aa4e..5a9a6922 100644 --- a/src/beeware_docs_tools/shared_content/en/contribute/what/review-pr.md +++ b/src/beeware_docs_tools/shared_content/en/contribute/what/review-pr.md @@ -16,6 +16,6 @@ As a first-time contributor, you should feel free to review any pull request you /// details-abstract | Providing a pull request review -{% include "contribute/how/review-pr.md" %} +{% include "how-to/contribute/how/review-pr.md" %} /// diff --git a/src/beeware_docs_tools/shared_content/en/contribute/what/translate.md b/src/beeware_docs_tools/shared_content/en/contribute/what/translate.md index 13da095c..48bd86e6 100644 --- a/src/beeware_docs_tools/shared_content/en/contribute/what/translate.md +++ b/src/beeware_docs_tools/shared_content/en/contribute/what/translate.md @@ -10,6 +10,6 @@ We use [DeepL](https://www.deepl.com/en/translator) for machine translation to p /// details-abstract | Translate content -{% include "contribute/how/translate.md" %} +{% include "how-to/contribute/how/translate.md" %} /// diff --git a/src/beeware_docs_tools/shared_content/en/contribute/what/triage.md b/src/beeware_docs_tools/shared_content/en/contribute/what/triage.md index ae63fbf6..535d90dd 100644 --- a/src/beeware_docs_tools/shared_content/en/contribute/what/triage.md +++ b/src/beeware_docs_tools/shared_content/en/contribute/what/triage.md @@ -8,6 +8,6 @@ Triaging an issue does not mean you are expected to fix it. Depending on the iss /// details-abstract | Reproduce the issue -{% include "contribute/how/reproduce-issue.md" %} +{% include "how-to/contribute/how/reproduce-issue.md" %} /// diff --git a/src/beeware_docs_tools/shared_content/en/contribute/what/use-tools.md b/src/beeware_docs_tools/shared_content/en/contribute/what/use-tools.md index 8db5c9d4..e2764250 100644 --- a/src/beeware_docs_tools/shared_content/en/contribute/what/use-tools.md +++ b/src/beeware_docs_tools/shared_content/en/contribute/what/use-tools.md @@ -10,12 +10,12 @@ If you do experience any problems, start a new discussion topic, as it may be th /// details-abstract | Submit a new issue -{% include "contribute/how/new-issue.md" %} +{% include "how-to/contribute/how/new-issue.md" %} /// /// details-abstract | Propose a new feature -{% include "contribute/how/propose-feature.md" %} +{% include "how-to/contribute/how/propose-feature.md" %} /// diff --git a/src/beeware_docs_tools/shared_content/en/contribute/what/write-docs.md b/src/beeware_docs_tools/shared_content/en/contribute/what/write-docs.md index d78c0b96..8fbc67be 100644 --- a/src/beeware_docs_tools/shared_content/en/contribute/what/write-docs.md +++ b/src/beeware_docs_tools/shared_content/en/contribute/what/write-docs.md @@ -49,48 +49,48 @@ A reference guide in baking might describe the types of sugar that could be used /// details-abstract | Proposing new documentation -{% include "contribute/how/propose-feature.md" %} +{% include "how-to/contribute/how/propose-feature.md" %} /// /// details-abstract | Set up a development environment -{% include "contribute/how/dev-environment.md" %} +{% include "how-to/contribute/how/dev-environment.md" %} /// /// details-abstract | Work from a branch -{% include "contribute/how/branches.md" %} +{% include "how-to/contribute/how/branches.md" %} /// /// details-abstract | Avoid scope creep -{% include "contribute/how/scope-creep.md" %} +{% include "how-to/contribute/how/scope-creep.md" %} /// /// details-abstract | Building documentation -{% include "contribute/how/build-docs.md" %} +{% include "how-to/contribute/how/build-docs.md" %} /// /// details-abstract | Writing documentation -{% include "contribute/how/write-docs.md" %} +{% include "how-to/contribute/how/write-docs.md" %} /// /// details-abstract | Add a change note -{% include "contribute/how/change-note.md" %} +{% include "how-to/contribute/how/change-note.md" %} /// /// details-abstract | Submit a pull request -{% include "contribute/how/submit-pr.md" %} +{% include "how-to/contribute/how/submit-pr.md" %} /// From e4262961e54ab8b35aea47cdd88e4050593bc85d Mon Sep 17 00:00:00 2001 From: Kattni Date: Wed, 3 Jun 2026 00:08:38 -0400 Subject: [PATCH 3/5] A better fix. --- docs/config.yml | 1 + docs/en/SUMMARY.md | 71 ++++++++++--------- .../contribute/first-time-contributors.md | 3 + .../how-to/contribute/how/branches.md | 2 +- .../how-to/contribute/how/build-docs.md | 2 +- .../how-to/contribute/how/change-note.md | 3 + .../how-to/contribute/how/dev-environment.md | 3 + .../how-to/contribute/how/new-issue.md | 3 + .../how-to/contribute/how/propose-feature.md | 2 +- .../how-to/contribute/how/reproduce-issue.md | 2 +- .../how-to/contribute/how/review-pr.md | 3 + .../how-to/contribute/how/scope-creep.md | 3 + .../how-to/contribute/how/submit-pr.md | 2 +- .../how-to/contribute/how/translate.md | 3 + .../how-to/contribute/how/write-code.md | 2 +- .../how-to/contribute/how/write-docs.md | 2 +- .../how-to/contribute/index.md | 3 + .../how-to/contribute/next/pr-review.md | 3 + .../how-to/contribute/next/release.md | 3 + .../how-to/contribute/policies/ai-policy.md | 3 + .../contribute/style/code-style-guide.md | 3 + .../contribute/style/docs-style-guide.md | 3 + .../how-to/contribute/what/fix-issue.md | 3 + .../contribute/what/implement-feature.md | 3 + .../how-to/contribute/what/propose-feature.md | 3 + .../how-to/contribute/what/review-pr.md | 3 + .../how-to/contribute/what/translate.md | 3 + .../how-to/contribute/what/triage.md | 3 + .../how-to/contribute/what/use-tools.md | 3 + .../how-to/contribute/what/write-docs.md | 3 + docs/en/{how-to => content_test_bed}/index.md | 0 .../contribute/first-time-contributors.md | 3 - docs/en/how-to/contribute/how/change-note.md | 3 - .../how-to/contribute/how/dev-environment.md | 3 - docs/en/how-to/contribute/how/new-issue.md | 3 - docs/en/how-to/contribute/how/review-pr.md | 3 - docs/en/how-to/contribute/how/scope-creep.md | 3 - docs/en/how-to/contribute/how/translate.md | 3 - docs/en/how-to/contribute/index.md | 3 - docs/en/how-to/contribute/next/pr-review.md | 3 - docs/en/how-to/contribute/next/release.md | 3 - .../how-to/contribute/policies/ai-policy.md | 3 - .../contribute/style/code-style-guide.md | 3 - .../contribute/style/docs-style-guide.md | 3 - docs/en/how-to/contribute/what/fix-issue.md | 3 - .../contribute/what/implement-feature.md | 3 - .../how-to/contribute/what/propose-feature.md | 3 - docs/en/how-to/contribute/what/review-pr.md | 3 - docs/en/how-to/contribute/what/translate.md | 3 - docs/en/how-to/contribute/what/triage.md | 3 - docs/en/how-to/contribute/what/use-tools.md | 3 - docs/en/how-to/contribute/what/write-docs.md | 3 - src/beeware_docs_tools/md_tempdir.py | 8 ++- .../contribute/first-time-contributors.md | 0 .../{ => _shared}/contribute/how/branches.md | 0 .../contribute/how/build-docs.md | 0 .../contribute/how/change-note.md | 0 .../contribute/how/dev-environment.md | 0 .../{ => _shared}/contribute/how/new-issue.md | 0 .../contribute/how/propose-feature.md | 0 .../contribute/how/reproduce-issue.md | 0 .../{ => _shared}/contribute/how/review-pr.md | 0 .../contribute/how/scope-creep.md | 0 .../{ => _shared}/contribute/how/submit-pr.md | 0 .../{ => _shared}/contribute/how/translate.md | 0 .../contribute/how/write-code.md | 0 .../contribute/how/write-docs.md | 0 .../en/{ => _shared}/contribute/index.md | 0 .../contribute/next/pr-review.md | 0 .../{ => _shared}/contribute/next/release.md | 0 .../contribute/policies/ai-policy.md | 0 .../contribute/style/code-style-guide.md | 0 .../contribute/style/docs-style-guide.md | 0 .../contribute/what/fix-issue.md | 16 ++--- .../contribute/what/implement-feature.md | 16 ++--- .../contribute/what/propose-feature.md | 2 +- .../contribute/what/review-pr.md | 2 +- .../contribute/what/translate.md | 2 +- .../{ => _shared}/contribute/what/triage.md | 2 +- .../contribute/what/use-tools.md | 4 +- .../contribute/what/write-docs.md | 16 ++--- 81 files changed, 143 insertions(+), 137 deletions(-) create mode 100644 docs/en/content_test_bed/how-to/contribute/first-time-contributors.md rename docs/en/{ => content_test_bed}/how-to/contribute/how/branches.md (51%) rename docs/en/{ => content_test_bed}/how-to/contribute/how/build-docs.md (85%) create mode 100644 docs/en/content_test_bed/how-to/contribute/how/change-note.md create mode 100644 docs/en/content_test_bed/how-to/contribute/how/dev-environment.md create mode 100644 docs/en/content_test_bed/how-to/contribute/how/new-issue.md rename docs/en/{ => content_test_bed}/how-to/contribute/how/propose-feature.md (74%) rename docs/en/{ => content_test_bed}/how-to/contribute/how/reproduce-issue.md (87%) create mode 100644 docs/en/content_test_bed/how-to/contribute/how/review-pr.md create mode 100644 docs/en/content_test_bed/how-to/contribute/how/scope-creep.md rename docs/en/{ => content_test_bed}/how-to/contribute/how/submit-pr.md (89%) create mode 100644 docs/en/content_test_bed/how-to/contribute/how/translate.md rename docs/en/{ => content_test_bed}/how-to/contribute/how/write-code.md (87%) rename docs/en/{ => content_test_bed}/how-to/contribute/how/write-docs.md (88%) create mode 100644 docs/en/content_test_bed/how-to/contribute/index.md create mode 100644 docs/en/content_test_bed/how-to/contribute/next/pr-review.md create mode 100644 docs/en/content_test_bed/how-to/contribute/next/release.md create mode 100644 docs/en/content_test_bed/how-to/contribute/policies/ai-policy.md create mode 100644 docs/en/content_test_bed/how-to/contribute/style/code-style-guide.md create mode 100644 docs/en/content_test_bed/how-to/contribute/style/docs-style-guide.md create mode 100644 docs/en/content_test_bed/how-to/contribute/what/fix-issue.md create mode 100644 docs/en/content_test_bed/how-to/contribute/what/implement-feature.md create mode 100644 docs/en/content_test_bed/how-to/contribute/what/propose-feature.md create mode 100644 docs/en/content_test_bed/how-to/contribute/what/review-pr.md create mode 100644 docs/en/content_test_bed/how-to/contribute/what/translate.md create mode 100644 docs/en/content_test_bed/how-to/contribute/what/triage.md create mode 100644 docs/en/content_test_bed/how-to/contribute/what/use-tools.md create mode 100644 docs/en/content_test_bed/how-to/contribute/what/write-docs.md rename docs/en/{how-to => content_test_bed}/index.md (100%) delete mode 100644 docs/en/how-to/contribute/first-time-contributors.md delete mode 100644 docs/en/how-to/contribute/how/change-note.md delete mode 100644 docs/en/how-to/contribute/how/dev-environment.md delete mode 100644 docs/en/how-to/contribute/how/new-issue.md delete mode 100644 docs/en/how-to/contribute/how/review-pr.md delete mode 100644 docs/en/how-to/contribute/how/scope-creep.md delete mode 100644 docs/en/how-to/contribute/how/translate.md delete mode 100644 docs/en/how-to/contribute/index.md delete mode 100644 docs/en/how-to/contribute/next/pr-review.md delete mode 100644 docs/en/how-to/contribute/next/release.md delete mode 100644 docs/en/how-to/contribute/policies/ai-policy.md delete mode 100644 docs/en/how-to/contribute/style/code-style-guide.md delete mode 100644 docs/en/how-to/contribute/style/docs-style-guide.md delete mode 100644 docs/en/how-to/contribute/what/fix-issue.md delete mode 100644 docs/en/how-to/contribute/what/implement-feature.md delete mode 100644 docs/en/how-to/contribute/what/propose-feature.md delete mode 100644 docs/en/how-to/contribute/what/review-pr.md delete mode 100644 docs/en/how-to/contribute/what/translate.md delete mode 100644 docs/en/how-to/contribute/what/triage.md delete mode 100644 docs/en/how-to/contribute/what/use-tools.md delete mode 100644 docs/en/how-to/contribute/what/write-docs.md rename src/beeware_docs_tools/shared_content/en/{ => _shared}/contribute/first-time-contributors.md (100%) rename src/beeware_docs_tools/shared_content/en/{ => _shared}/contribute/how/branches.md (100%) rename src/beeware_docs_tools/shared_content/en/{ => _shared}/contribute/how/build-docs.md (100%) rename src/beeware_docs_tools/shared_content/en/{ => _shared}/contribute/how/change-note.md (100%) rename src/beeware_docs_tools/shared_content/en/{ => _shared}/contribute/how/dev-environment.md (100%) rename src/beeware_docs_tools/shared_content/en/{ => _shared}/contribute/how/new-issue.md (100%) rename src/beeware_docs_tools/shared_content/en/{ => _shared}/contribute/how/propose-feature.md (100%) rename src/beeware_docs_tools/shared_content/en/{ => _shared}/contribute/how/reproduce-issue.md (100%) rename src/beeware_docs_tools/shared_content/en/{ => _shared}/contribute/how/review-pr.md (100%) rename src/beeware_docs_tools/shared_content/en/{ => _shared}/contribute/how/scope-creep.md (100%) rename src/beeware_docs_tools/shared_content/en/{ => _shared}/contribute/how/submit-pr.md (100%) rename src/beeware_docs_tools/shared_content/en/{ => _shared}/contribute/how/translate.md (100%) rename src/beeware_docs_tools/shared_content/en/{ => _shared}/contribute/how/write-code.md (100%) rename src/beeware_docs_tools/shared_content/en/{ => _shared}/contribute/how/write-docs.md (100%) rename src/beeware_docs_tools/shared_content/en/{ => _shared}/contribute/index.md (100%) rename src/beeware_docs_tools/shared_content/en/{ => _shared}/contribute/next/pr-review.md (100%) rename src/beeware_docs_tools/shared_content/en/{ => _shared}/contribute/next/release.md (100%) rename src/beeware_docs_tools/shared_content/en/{ => _shared}/contribute/policies/ai-policy.md (100%) rename src/beeware_docs_tools/shared_content/en/{ => _shared}/contribute/style/code-style-guide.md (100%) rename src/beeware_docs_tools/shared_content/en/{ => _shared}/contribute/style/docs-style-guide.md (100%) rename src/beeware_docs_tools/shared_content/en/{ => _shared}/contribute/what/fix-issue.md (87%) rename src/beeware_docs_tools/shared_content/en/{ => _shared}/contribute/what/implement-feature.md (78%) rename src/beeware_docs_tools/shared_content/en/{ => _shared}/contribute/what/propose-feature.md (98%) rename src/beeware_docs_tools/shared_content/en/{ => _shared}/contribute/what/review-pr.md (96%) rename src/beeware_docs_tools/shared_content/en/{ => _shared}/contribute/what/translate.md (95%) rename src/beeware_docs_tools/shared_content/en/{ => _shared}/contribute/what/triage.md (94%) rename src/beeware_docs_tools/shared_content/en/{ => _shared}/contribute/what/use-tools.md (90%) rename src/beeware_docs_tools/shared_content/en/{ => _shared}/contribute/what/write-docs.md (93%) diff --git a/docs/config.yml b/docs/config.yml index 5c5fe208..d7ff0847 100644 --- a/docs/config.yml +++ b/docs/config.yml @@ -22,6 +22,7 @@ extra: translated: true # false hides content related to building translations. Default: false. hide_coverage: false # true hides content related to code coverage. Default: false. macos_only: false # true hides tabbed content, and displays only macOS instructions. Default: false. + contribution_guide_root: content_test_bed/how-to/contribute alternate: - name: English link: /en/ diff --git a/docs/en/SUMMARY.md b/docs/en/SUMMARY.md index 7ef01873..23dae629 100644 --- a/docs/en/SUMMARY.md +++ b/docs/en/SUMMARY.md @@ -9,38 +9,39 @@ search: - [Section two](section_two/index.md) - [Section three](section_three/index.md) - ./section_three/* -- [How-to guides](how-to/index.md) - - Contribute - - [Contributing](how-to/contribute/index.md) - - [First-time contributors](how-to/contribute/first-time-contributors.md) - - What can I do? - - [Fix an issue](how-to/contribute/what/fix-issue.md) - - [Implement a new feature](how-to/contribute/what/implement-feature.md) - - [Write documentation](how-to/contribute/what/write-docs.md) - - [Triage an issue](how-to/contribute/what/triage.md) - - [Review a pull request](how-to/contribute/what/review-pr.md) - - [Propose a new feature](how-to/contribute/what/propose-feature.md) - - [Translate content](how-to/contribute/what/translate.md) - - [Use the tools](how-to/contribute/what/use-tools.md) - - How do I contribute? - - [Setting up a development environment](how-to/contribute/how/dev-environment.md) - - [Reproducing an issue](how-to/contribute/how/reproduce-issue.md) - - [Working from a branch](how-to/contribute/how/branches.md) - - [Avoiding scope creep](how-to/contribute/how/scope-creep.md) - - [Writing, running, and testing code](how-to/contribute/how/write-code.md) - - [Building documentation](how-to/contribute/how/build-docs.md) - - [Writing documentation](how-to/contribute/how/write-docs.md) - - [Adding a change note](how-to/contribute/how/change-note.md) - - [Submitting a pull request](how-to/contribute/how/submit-pr.md) - - [Providing a review](how-to/contribute/how/review-pr.md) - - [Submitting a new issue](how-to/contribute/how/new-issue.md) - - [Proposing a new feature](how-to/contribute/how/propose-feature.md) - - [Translating content](how-to/contribute/how/translate.md) - - What happens next? - - [Pull request review process](how-to/contribute/next/pr-review.md) - - [Release process](how-to/contribute/next/release.md) - - Policies - - [AI Policy](how-to/contribute/policies/ai-policy.md) - - Style guides - - [Code style guide](how-to/contribute/style/code-style-guide.md) - - [Documentation style guide](how-to/contribute/style/docs-style-guide.md) +- [Shared content testbed](content_test_bed/index.md) + - How-to guides + - [Contribute](content_test_bed/how-to/contribute/index.md) + - [Contributing](content_test_bed/how-to/contribute/index.md) + - [First-time contributors](content_test_bed/how-to/contribute/first-time-contributors.md) + - What can I do? + - [Fix an issue](content_test_bed/how-to/contribute/what/fix-issue.md) + - [Implement a new feature](content_test_bed/how-to/contribute/what/implement-feature.md) + - [Write documentation](content_test_bed/how-to/contribute/what/write-docs.md) + - [Triage an issue](content_test_bed/how-to/contribute/what/triage.md) + - [Review a pull request](content_test_bed/how-to/contribute/what/review-pr.md) + - [Propose a new feature](content_test_bed/how-to/contribute/what/propose-feature.md) + - [Translate content](content_test_bed/how-to/contribute/what/translate.md) + - [Use the tools](content_test_bed/how-to/contribute/what/use-tools.md) + - How do I contribute? + - [Setting up a development environment](content_test_bed/how-to/contribute/how/dev-environment.md) + - [Reproducing an issue](content_test_bed/how-to/contribute/how/reproduce-issue.md) + - [Working from a branch](content_test_bed/how-to/contribute/how/branches.md) + - [Avoiding scope creep](content_test_bed/how-to/contribute/how/scope-creep.md) + - [Writing, running, and testing code](content_test_bed/how-to/contribute/how/write-code.md) + - [Building documentation](content_test_bed/how-to/contribute/how/build-docs.md) + - [Writing documentation](content_test_bed/how-to/contribute/how/write-docs.md) + - [Adding a change note](content_test_bed/how-to/contribute/how/change-note.md) + - [Submitting a pull request](content_test_bed/how-to/contribute/how/submit-pr.md) + - [Providing a review](content_test_bed/how-to/contribute/how/review-pr.md) + - [Submitting a new issue](content_test_bed/how-to/contribute/how/new-issue.md) + - [Proposing a new feature](content_test_bed/how-to/contribute/how/propose-feature.md) + - [Translating content](content_test_bed/how-to/contribute/how/translate.md) + - What happens next? + - [Pull request review process](content_test_bed/how-to/contribute/next/pr-review.md) + - [Release process](content_test_bed/how-to/contribute/next/release.md) + - Policies + - [AI Policy](content_test_bed/how-to/contribute/policies/ai-policy.md) + - Style guides + - [Code style guide](content_test_bed/how-to/contribute/style/code-style-guide.md) + - [Documentation style guide](content_test_bed/how-to/contribute/style/docs-style-guide.md) diff --git a/docs/en/content_test_bed/how-to/contribute/first-time-contributors.md b/docs/en/content_test_bed/how-to/contribute/first-time-contributors.md new file mode 100644 index 00000000..04a45720 --- /dev/null +++ b/docs/en/content_test_bed/how-to/contribute/first-time-contributors.md @@ -0,0 +1,3 @@ +# First-time contributors + +{% extends "_shared/contribute/first-time-contributors.md" %} diff --git a/docs/en/how-to/contribute/how/branches.md b/docs/en/content_test_bed/how-to/contribute/how/branches.md similarity index 51% rename from docs/en/how-to/contribute/how/branches.md rename to docs/en/content_test_bed/how-to/contribute/how/branches.md index f230e8ca..88d2da3c 100644 --- a/docs/en/how-to/contribute/how/branches.md +++ b/docs/en/content_test_bed/how-to/contribute/how/branches.md @@ -1,3 +1,3 @@ # Work from a feature branch, not your `main` branch -{% extends "contribute/how/branches.md" %} +{% extends "_shared/contribute/how/branches.md" %} diff --git a/docs/en/how-to/contribute/how/build-docs.md b/docs/en/content_test_bed/how-to/contribute/how/build-docs.md similarity index 85% rename from docs/en/how-to/contribute/how/build-docs.md rename to docs/en/content_test_bed/how-to/contribute/how/build-docs.md index 3e6936d6..7755ef97 100644 --- a/docs/en/how-to/contribute/how/build-docs.md +++ b/docs/en/content_test_bed/how-to/contribute/how/build-docs.md @@ -1,6 +1,6 @@ # Building documentation -{% extends "contribute/how/build-docs.md" %} +{% extends "_shared/contribute/how/build-docs.md" %} {% block front_matter %} diff --git a/docs/en/content_test_bed/how-to/contribute/how/change-note.md b/docs/en/content_test_bed/how-to/contribute/how/change-note.md new file mode 100644 index 00000000..f499d90d --- /dev/null +++ b/docs/en/content_test_bed/how-to/contribute/how/change-note.md @@ -0,0 +1,3 @@ +# Adding change information for release notes + +{% extends "_shared/contribute/how/change-note.md" %} diff --git a/docs/en/content_test_bed/how-to/contribute/how/dev-environment.md b/docs/en/content_test_bed/how-to/contribute/how/dev-environment.md new file mode 100644 index 00000000..2f2e1067 --- /dev/null +++ b/docs/en/content_test_bed/how-to/contribute/how/dev-environment.md @@ -0,0 +1,3 @@ +# Setting up a development environment + +{% extends "_shared/contribute/how/dev-environment.md" %} diff --git a/docs/en/content_test_bed/how-to/contribute/how/new-issue.md b/docs/en/content_test_bed/how-to/contribute/how/new-issue.md new file mode 100644 index 00000000..30f3f0c0 --- /dev/null +++ b/docs/en/content_test_bed/how-to/contribute/how/new-issue.md @@ -0,0 +1,3 @@ +# Submitting a new issue + +{% extends "_shared/contribute/how/new-issue.md" %} diff --git a/docs/en/how-to/contribute/how/propose-feature.md b/docs/en/content_test_bed/how-to/contribute/how/propose-feature.md similarity index 74% rename from docs/en/how-to/contribute/how/propose-feature.md rename to docs/en/content_test_bed/how-to/contribute/how/propose-feature.md index 008b9d6f..cd274895 100644 --- a/docs/en/how-to/contribute/how/propose-feature.md +++ b/docs/en/content_test_bed/how-to/contribute/how/propose-feature.md @@ -1,6 +1,6 @@ # Proposing a new feature -{% extends "contribute/how/propose-feature.md" %} +{% extends "_shared/contribute/how/propose-feature.md" %} {% block end_matter %} diff --git a/docs/en/how-to/contribute/how/reproduce-issue.md b/docs/en/content_test_bed/how-to/contribute/how/reproduce-issue.md similarity index 87% rename from docs/en/how-to/contribute/how/reproduce-issue.md rename to docs/en/content_test_bed/how-to/contribute/how/reproduce-issue.md index 3bddd945..e765196c 100644 --- a/docs/en/how-to/contribute/how/reproduce-issue.md +++ b/docs/en/content_test_bed/how-to/contribute/how/reproduce-issue.md @@ -1,6 +1,6 @@ # Reproducing an issue -{% extends "contribute/how/reproduce-issue.md" %} +{% extends "_shared/contribute/how/reproduce-issue.md" %} {% block front_matter %} diff --git a/docs/en/content_test_bed/how-to/contribute/how/review-pr.md b/docs/en/content_test_bed/how-to/contribute/how/review-pr.md new file mode 100644 index 00000000..30e8d2fa --- /dev/null +++ b/docs/en/content_test_bed/how-to/contribute/how/review-pr.md @@ -0,0 +1,3 @@ +# Providing a pull request review + +{% extends "_shared/contribute/how/review-pr.md" %} diff --git a/docs/en/content_test_bed/how-to/contribute/how/scope-creep.md b/docs/en/content_test_bed/how-to/contribute/how/scope-creep.md new file mode 100644 index 00000000..22718a3f --- /dev/null +++ b/docs/en/content_test_bed/how-to/contribute/how/scope-creep.md @@ -0,0 +1,3 @@ +# Avoiding scope creep + +{% extends "_shared/contribute/how/scope-creep.md" %} diff --git a/docs/en/how-to/contribute/how/submit-pr.md b/docs/en/content_test_bed/how-to/contribute/how/submit-pr.md similarity index 89% rename from docs/en/how-to/contribute/how/submit-pr.md rename to docs/en/content_test_bed/how-to/contribute/how/submit-pr.md index 6e71a9b1..5937a49d 100644 --- a/docs/en/how-to/contribute/how/submit-pr.md +++ b/docs/en/content_test_bed/how-to/contribute/how/submit-pr.md @@ -1,6 +1,6 @@ # Submitting a pull request -{% extends "contribute/how/submit-pr.md" %} +{% extends "_shared/contribute/how/submit-pr.md" %} {% block end_matter %} diff --git a/docs/en/content_test_bed/how-to/contribute/how/translate.md b/docs/en/content_test_bed/how-to/contribute/how/translate.md new file mode 100644 index 00000000..1eea13cf --- /dev/null +++ b/docs/en/content_test_bed/how-to/contribute/how/translate.md @@ -0,0 +1,3 @@ +# Translating content + +{% extends "_shared/contribute/how/translate.md" %} diff --git a/docs/en/how-to/contribute/how/write-code.md b/docs/en/content_test_bed/how-to/contribute/how/write-code.md similarity index 87% rename from docs/en/how-to/contribute/how/write-code.md rename to docs/en/content_test_bed/how-to/contribute/how/write-code.md index aede2e0a..a167a69c 100644 --- a/docs/en/how-to/contribute/how/write-code.md +++ b/docs/en/content_test_bed/how-to/contribute/how/write-code.md @@ -1,6 +1,6 @@ # Writing, running, and testing code -{% extends "contribute/how/write-code.md" %} +{% extends "_shared/contribute/how/write-code.md" %} {% block front_matter %} diff --git a/docs/en/how-to/contribute/how/write-docs.md b/docs/en/content_test_bed/how-to/contribute/how/write-docs.md similarity index 88% rename from docs/en/how-to/contribute/how/write-docs.md rename to docs/en/content_test_bed/how-to/contribute/how/write-docs.md index dc4862f3..146b398a 100644 --- a/docs/en/how-to/contribute/how/write-docs.md +++ b/docs/en/content_test_bed/how-to/contribute/how/write-docs.md @@ -1,6 +1,6 @@ # Writing documentation -{% extends "contribute/how/write-docs.md" %} +{% extends "_shared/contribute/how/write-docs.md" %} {% block front_matter %} diff --git a/docs/en/content_test_bed/how-to/contribute/index.md b/docs/en/content_test_bed/how-to/contribute/index.md new file mode 100644 index 00000000..e828b1f1 --- /dev/null +++ b/docs/en/content_test_bed/how-to/contribute/index.md @@ -0,0 +1,3 @@ +# Contributing to {{ formal_name }} + +{% extends "_shared/contribute/index.md" %} diff --git a/docs/en/content_test_bed/how-to/contribute/next/pr-review.md b/docs/en/content_test_bed/how-to/contribute/next/pr-review.md new file mode 100644 index 00000000..65cfdfc7 --- /dev/null +++ b/docs/en/content_test_bed/how-to/contribute/next/pr-review.md @@ -0,0 +1,3 @@ +# Receiving a pull request review + +{% extends "_shared/contribute/next/pr-review.md" %} diff --git a/docs/en/content_test_bed/how-to/contribute/next/release.md b/docs/en/content_test_bed/how-to/contribute/next/release.md new file mode 100644 index 00000000..44a7772c --- /dev/null +++ b/docs/en/content_test_bed/how-to/contribute/next/release.md @@ -0,0 +1,3 @@ +# The release process + +{% extends "_shared/contribute/next/release.md" %} diff --git a/docs/en/content_test_bed/how-to/contribute/policies/ai-policy.md b/docs/en/content_test_bed/how-to/contribute/policies/ai-policy.md new file mode 100644 index 00000000..3e9364b2 --- /dev/null +++ b/docs/en/content_test_bed/how-to/contribute/policies/ai-policy.md @@ -0,0 +1,3 @@ + + +{% extends "_shared/contribute/policies/ai-policy.md" %} diff --git a/docs/en/content_test_bed/how-to/contribute/style/code-style-guide.md b/docs/en/content_test_bed/how-to/contribute/style/code-style-guide.md new file mode 100644 index 00000000..43f8d1f7 --- /dev/null +++ b/docs/en/content_test_bed/how-to/contribute/style/code-style-guide.md @@ -0,0 +1,3 @@ +# Code style guide + +{% extends "_shared/contribute/style/code-style-guide.md" %} diff --git a/docs/en/content_test_bed/how-to/contribute/style/docs-style-guide.md b/docs/en/content_test_bed/how-to/contribute/style/docs-style-guide.md new file mode 100644 index 00000000..5164a0a1 --- /dev/null +++ b/docs/en/content_test_bed/how-to/contribute/style/docs-style-guide.md @@ -0,0 +1,3 @@ +# Documentation style guide + +{% extends "_shared/contribute/style/docs-style-guide.md" %} diff --git a/docs/en/content_test_bed/how-to/contribute/what/fix-issue.md b/docs/en/content_test_bed/how-to/contribute/what/fix-issue.md new file mode 100644 index 00000000..8cdb8bf1 --- /dev/null +++ b/docs/en/content_test_bed/how-to/contribute/what/fix-issue.md @@ -0,0 +1,3 @@ +# Fixing an issue + +{% extends "_shared/contribute/what/fix-issue.md" %} diff --git a/docs/en/content_test_bed/how-to/contribute/what/implement-feature.md b/docs/en/content_test_bed/how-to/contribute/what/implement-feature.md new file mode 100644 index 00000000..c1ecd287 --- /dev/null +++ b/docs/en/content_test_bed/how-to/contribute/what/implement-feature.md @@ -0,0 +1,3 @@ +# Implementing a new feature + +{% extends "_shared/contribute/what/implement-feature.md" %} diff --git a/docs/en/content_test_bed/how-to/contribute/what/propose-feature.md b/docs/en/content_test_bed/how-to/contribute/what/propose-feature.md new file mode 100644 index 00000000..c8152055 --- /dev/null +++ b/docs/en/content_test_bed/how-to/contribute/what/propose-feature.md @@ -0,0 +1,3 @@ +# Proposing a new feature + +{% extends "_shared/contribute/what/propose-feature.md" %} diff --git a/docs/en/content_test_bed/how-to/contribute/what/review-pr.md b/docs/en/content_test_bed/how-to/contribute/what/review-pr.md new file mode 100644 index 00000000..9c4b9f80 --- /dev/null +++ b/docs/en/content_test_bed/how-to/contribute/what/review-pr.md @@ -0,0 +1,3 @@ +# Providing a pull request review + +{% extends "_shared/contribute/what/review-pr.md" %} diff --git a/docs/en/content_test_bed/how-to/contribute/what/translate.md b/docs/en/content_test_bed/how-to/contribute/what/translate.md new file mode 100644 index 00000000..c015732f --- /dev/null +++ b/docs/en/content_test_bed/how-to/contribute/what/translate.md @@ -0,0 +1,3 @@ +# Translating content + +{% extends "_shared/contribute/what/translate.md" %} diff --git a/docs/en/content_test_bed/how-to/contribute/what/triage.md b/docs/en/content_test_bed/how-to/contribute/what/triage.md new file mode 100644 index 00000000..ead5509d --- /dev/null +++ b/docs/en/content_test_bed/how-to/contribute/what/triage.md @@ -0,0 +1,3 @@ +# Triaging an issue + +{% extends "_shared/contribute/what/triage.md" %} diff --git a/docs/en/content_test_bed/how-to/contribute/what/use-tools.md b/docs/en/content_test_bed/how-to/contribute/what/use-tools.md new file mode 100644 index 00000000..cc775326 --- /dev/null +++ b/docs/en/content_test_bed/how-to/contribute/what/use-tools.md @@ -0,0 +1,3 @@ +# Using the tools + +{% extends "_shared/contribute/what/use-tools.md" %} diff --git a/docs/en/content_test_bed/how-to/contribute/what/write-docs.md b/docs/en/content_test_bed/how-to/contribute/what/write-docs.md new file mode 100644 index 00000000..3be56fed --- /dev/null +++ b/docs/en/content_test_bed/how-to/contribute/what/write-docs.md @@ -0,0 +1,3 @@ +# Adding documentation + +{% extends "_shared/contribute/what/write-docs.md" %} diff --git a/docs/en/how-to/index.md b/docs/en/content_test_bed/index.md similarity index 100% rename from docs/en/how-to/index.md rename to docs/en/content_test_bed/index.md diff --git a/docs/en/how-to/contribute/first-time-contributors.md b/docs/en/how-to/contribute/first-time-contributors.md deleted file mode 100644 index 42600289..00000000 --- a/docs/en/how-to/contribute/first-time-contributors.md +++ /dev/null @@ -1,3 +0,0 @@ -# First-time contributors - -{% extends "contribute/first-time-contributors.md" %} diff --git a/docs/en/how-to/contribute/how/change-note.md b/docs/en/how-to/contribute/how/change-note.md deleted file mode 100644 index 236fac69..00000000 --- a/docs/en/how-to/contribute/how/change-note.md +++ /dev/null @@ -1,3 +0,0 @@ -# Adding change information for release notes - -{% extends "contribute/how/change-note.md" %} diff --git a/docs/en/how-to/contribute/how/dev-environment.md b/docs/en/how-to/contribute/how/dev-environment.md deleted file mode 100644 index fb52b53b..00000000 --- a/docs/en/how-to/contribute/how/dev-environment.md +++ /dev/null @@ -1,3 +0,0 @@ -# Setting up a development environment - -{% extends "contribute/how/dev-environment.md" %} diff --git a/docs/en/how-to/contribute/how/new-issue.md b/docs/en/how-to/contribute/how/new-issue.md deleted file mode 100644 index fceca0ed..00000000 --- a/docs/en/how-to/contribute/how/new-issue.md +++ /dev/null @@ -1,3 +0,0 @@ -# Submitting a new issue - -{% extends "contribute/how/new-issue.md" %} diff --git a/docs/en/how-to/contribute/how/review-pr.md b/docs/en/how-to/contribute/how/review-pr.md deleted file mode 100644 index 047a0b43..00000000 --- a/docs/en/how-to/contribute/how/review-pr.md +++ /dev/null @@ -1,3 +0,0 @@ -# Providing a pull request review - -{% extends "contribute/how/review-pr.md" %} diff --git a/docs/en/how-to/contribute/how/scope-creep.md b/docs/en/how-to/contribute/how/scope-creep.md deleted file mode 100644 index c2824279..00000000 --- a/docs/en/how-to/contribute/how/scope-creep.md +++ /dev/null @@ -1,3 +0,0 @@ -# Avoiding scope creep - -{% extends "contribute/how/scope-creep.md" %} diff --git a/docs/en/how-to/contribute/how/translate.md b/docs/en/how-to/contribute/how/translate.md deleted file mode 100644 index 9d40413b..00000000 --- a/docs/en/how-to/contribute/how/translate.md +++ /dev/null @@ -1,3 +0,0 @@ -# Translating content - -{% extends "contribute/how/translate.md" %} diff --git a/docs/en/how-to/contribute/index.md b/docs/en/how-to/contribute/index.md deleted file mode 100644 index b14329fe..00000000 --- a/docs/en/how-to/contribute/index.md +++ /dev/null @@ -1,3 +0,0 @@ -# Contributing to {{ formal_name }} - -{% extends "contribute/index.md" %} diff --git a/docs/en/how-to/contribute/next/pr-review.md b/docs/en/how-to/contribute/next/pr-review.md deleted file mode 100644 index f2a408fe..00000000 --- a/docs/en/how-to/contribute/next/pr-review.md +++ /dev/null @@ -1,3 +0,0 @@ -# Receiving a pull request review - -{% extends "contribute/next/pr-review.md" %} diff --git a/docs/en/how-to/contribute/next/release.md b/docs/en/how-to/contribute/next/release.md deleted file mode 100644 index 3f9995e3..00000000 --- a/docs/en/how-to/contribute/next/release.md +++ /dev/null @@ -1,3 +0,0 @@ -# The release process - -{% extends "contribute/next/release.md" %} diff --git a/docs/en/how-to/contribute/policies/ai-policy.md b/docs/en/how-to/contribute/policies/ai-policy.md deleted file mode 100644 index e17e9998..00000000 --- a/docs/en/how-to/contribute/policies/ai-policy.md +++ /dev/null @@ -1,3 +0,0 @@ - - -{% extends "contribute/policies/ai-policy.md" %} diff --git a/docs/en/how-to/contribute/style/code-style-guide.md b/docs/en/how-to/contribute/style/code-style-guide.md deleted file mode 100644 index bba1179b..00000000 --- a/docs/en/how-to/contribute/style/code-style-guide.md +++ /dev/null @@ -1,3 +0,0 @@ -# Code style guide - -{% extends "contribute/style/code-style-guide.md" %} diff --git a/docs/en/how-to/contribute/style/docs-style-guide.md b/docs/en/how-to/contribute/style/docs-style-guide.md deleted file mode 100644 index 1b0ea184..00000000 --- a/docs/en/how-to/contribute/style/docs-style-guide.md +++ /dev/null @@ -1,3 +0,0 @@ -# Documentation style guide - -{% extends "contribute/style/docs-style-guide.md" %} diff --git a/docs/en/how-to/contribute/what/fix-issue.md b/docs/en/how-to/contribute/what/fix-issue.md deleted file mode 100644 index d30549e8..00000000 --- a/docs/en/how-to/contribute/what/fix-issue.md +++ /dev/null @@ -1,3 +0,0 @@ -# Fixing an issue - -{% extends "contribute/what/fix-issue.md" %} diff --git a/docs/en/how-to/contribute/what/implement-feature.md b/docs/en/how-to/contribute/what/implement-feature.md deleted file mode 100644 index 4af9f120..00000000 --- a/docs/en/how-to/contribute/what/implement-feature.md +++ /dev/null @@ -1,3 +0,0 @@ -# Implementing a new feature - -{% extends "contribute/what/implement-feature.md" %} diff --git a/docs/en/how-to/contribute/what/propose-feature.md b/docs/en/how-to/contribute/what/propose-feature.md deleted file mode 100644 index 3b2b1eaf..00000000 --- a/docs/en/how-to/contribute/what/propose-feature.md +++ /dev/null @@ -1,3 +0,0 @@ -# Proposing a new feature - -{% extends "contribute/what/propose-feature.md" %} diff --git a/docs/en/how-to/contribute/what/review-pr.md b/docs/en/how-to/contribute/what/review-pr.md deleted file mode 100644 index aa2fe0ab..00000000 --- a/docs/en/how-to/contribute/what/review-pr.md +++ /dev/null @@ -1,3 +0,0 @@ -# Providing a pull request review - -{% extends "contribute/what/review-pr.md" %} diff --git a/docs/en/how-to/contribute/what/translate.md b/docs/en/how-to/contribute/what/translate.md deleted file mode 100644 index 9d4a07d9..00000000 --- a/docs/en/how-to/contribute/what/translate.md +++ /dev/null @@ -1,3 +0,0 @@ -# Translating content - -{% extends "contribute/what/translate.md" %} diff --git a/docs/en/how-to/contribute/what/triage.md b/docs/en/how-to/contribute/what/triage.md deleted file mode 100644 index ec4bc414..00000000 --- a/docs/en/how-to/contribute/what/triage.md +++ /dev/null @@ -1,3 +0,0 @@ -# Triaging an issue - -{% extends "contribute/what/triage.md" %} diff --git a/docs/en/how-to/contribute/what/use-tools.md b/docs/en/how-to/contribute/what/use-tools.md deleted file mode 100644 index 83155a3b..00000000 --- a/docs/en/how-to/contribute/what/use-tools.md +++ /dev/null @@ -1,3 +0,0 @@ -# Using the tools - -{% extends "contribute/what/use-tools.md" %} diff --git a/docs/en/how-to/contribute/what/write-docs.md b/docs/en/how-to/contribute/what/write-docs.md deleted file mode 100644 index b1a973fb..00000000 --- a/docs/en/how-to/contribute/what/write-docs.md +++ /dev/null @@ -1,3 +0,0 @@ -# Adding documentation - -{% extends "contribute/what/write-docs.md" %} diff --git a/src/beeware_docs_tools/md_tempdir.py b/src/beeware_docs_tools/md_tempdir.py index 4ed77b79..e81090b1 100644 --- a/src/beeware_docs_tools/md_tempdir.py +++ b/src/beeware_docs_tools/md_tempdir.py @@ -68,12 +68,16 @@ def save_config(project_path, temp_md_path, config, language="en"): base_path = config["markdown_extensions"]["pymdownx.snippets"].get("base_path", []) + contribution_root = config["extra"].get( + "contribution_guide_root", "how-to/contribute" + ) + if language != "en": shared_content_path = temp_md_path.resolve() / f"shared_content/{language}" - local_docs_path = temp_md_path.resolve() / f"{language}" + local_docs_path = temp_md_path.resolve() / language / contribution_root else: shared_content_path = (Path(__file__).parent / "shared_content/en").resolve() - local_docs_path = (project_path / "docs/en").resolve() + local_docs_path = (project_path / "docs/en" / contribution_root).resolve() base_path.append(str(shared_content_path)) config["markdown_extensions"]["pymdownx.snippets"]["base_path"] = base_path diff --git a/src/beeware_docs_tools/shared_content/en/contribute/first-time-contributors.md b/src/beeware_docs_tools/shared_content/en/_shared/contribute/first-time-contributors.md similarity index 100% rename from src/beeware_docs_tools/shared_content/en/contribute/first-time-contributors.md rename to src/beeware_docs_tools/shared_content/en/_shared/contribute/first-time-contributors.md diff --git a/src/beeware_docs_tools/shared_content/en/contribute/how/branches.md b/src/beeware_docs_tools/shared_content/en/_shared/contribute/how/branches.md similarity index 100% rename from src/beeware_docs_tools/shared_content/en/contribute/how/branches.md rename to src/beeware_docs_tools/shared_content/en/_shared/contribute/how/branches.md diff --git a/src/beeware_docs_tools/shared_content/en/contribute/how/build-docs.md b/src/beeware_docs_tools/shared_content/en/_shared/contribute/how/build-docs.md similarity index 100% rename from src/beeware_docs_tools/shared_content/en/contribute/how/build-docs.md rename to src/beeware_docs_tools/shared_content/en/_shared/contribute/how/build-docs.md diff --git a/src/beeware_docs_tools/shared_content/en/contribute/how/change-note.md b/src/beeware_docs_tools/shared_content/en/_shared/contribute/how/change-note.md similarity index 100% rename from src/beeware_docs_tools/shared_content/en/contribute/how/change-note.md rename to src/beeware_docs_tools/shared_content/en/_shared/contribute/how/change-note.md diff --git a/src/beeware_docs_tools/shared_content/en/contribute/how/dev-environment.md b/src/beeware_docs_tools/shared_content/en/_shared/contribute/how/dev-environment.md similarity index 100% rename from src/beeware_docs_tools/shared_content/en/contribute/how/dev-environment.md rename to src/beeware_docs_tools/shared_content/en/_shared/contribute/how/dev-environment.md diff --git a/src/beeware_docs_tools/shared_content/en/contribute/how/new-issue.md b/src/beeware_docs_tools/shared_content/en/_shared/contribute/how/new-issue.md similarity index 100% rename from src/beeware_docs_tools/shared_content/en/contribute/how/new-issue.md rename to src/beeware_docs_tools/shared_content/en/_shared/contribute/how/new-issue.md diff --git a/src/beeware_docs_tools/shared_content/en/contribute/how/propose-feature.md b/src/beeware_docs_tools/shared_content/en/_shared/contribute/how/propose-feature.md similarity index 100% rename from src/beeware_docs_tools/shared_content/en/contribute/how/propose-feature.md rename to src/beeware_docs_tools/shared_content/en/_shared/contribute/how/propose-feature.md diff --git a/src/beeware_docs_tools/shared_content/en/contribute/how/reproduce-issue.md b/src/beeware_docs_tools/shared_content/en/_shared/contribute/how/reproduce-issue.md similarity index 100% rename from src/beeware_docs_tools/shared_content/en/contribute/how/reproduce-issue.md rename to src/beeware_docs_tools/shared_content/en/_shared/contribute/how/reproduce-issue.md diff --git a/src/beeware_docs_tools/shared_content/en/contribute/how/review-pr.md b/src/beeware_docs_tools/shared_content/en/_shared/contribute/how/review-pr.md similarity index 100% rename from src/beeware_docs_tools/shared_content/en/contribute/how/review-pr.md rename to src/beeware_docs_tools/shared_content/en/_shared/contribute/how/review-pr.md diff --git a/src/beeware_docs_tools/shared_content/en/contribute/how/scope-creep.md b/src/beeware_docs_tools/shared_content/en/_shared/contribute/how/scope-creep.md similarity index 100% rename from src/beeware_docs_tools/shared_content/en/contribute/how/scope-creep.md rename to src/beeware_docs_tools/shared_content/en/_shared/contribute/how/scope-creep.md diff --git a/src/beeware_docs_tools/shared_content/en/contribute/how/submit-pr.md b/src/beeware_docs_tools/shared_content/en/_shared/contribute/how/submit-pr.md similarity index 100% rename from src/beeware_docs_tools/shared_content/en/contribute/how/submit-pr.md rename to src/beeware_docs_tools/shared_content/en/_shared/contribute/how/submit-pr.md diff --git a/src/beeware_docs_tools/shared_content/en/contribute/how/translate.md b/src/beeware_docs_tools/shared_content/en/_shared/contribute/how/translate.md similarity index 100% rename from src/beeware_docs_tools/shared_content/en/contribute/how/translate.md rename to src/beeware_docs_tools/shared_content/en/_shared/contribute/how/translate.md diff --git a/src/beeware_docs_tools/shared_content/en/contribute/how/write-code.md b/src/beeware_docs_tools/shared_content/en/_shared/contribute/how/write-code.md similarity index 100% rename from src/beeware_docs_tools/shared_content/en/contribute/how/write-code.md rename to src/beeware_docs_tools/shared_content/en/_shared/contribute/how/write-code.md diff --git a/src/beeware_docs_tools/shared_content/en/contribute/how/write-docs.md b/src/beeware_docs_tools/shared_content/en/_shared/contribute/how/write-docs.md similarity index 100% rename from src/beeware_docs_tools/shared_content/en/contribute/how/write-docs.md rename to src/beeware_docs_tools/shared_content/en/_shared/contribute/how/write-docs.md diff --git a/src/beeware_docs_tools/shared_content/en/contribute/index.md b/src/beeware_docs_tools/shared_content/en/_shared/contribute/index.md similarity index 100% rename from src/beeware_docs_tools/shared_content/en/contribute/index.md rename to src/beeware_docs_tools/shared_content/en/_shared/contribute/index.md diff --git a/src/beeware_docs_tools/shared_content/en/contribute/next/pr-review.md b/src/beeware_docs_tools/shared_content/en/_shared/contribute/next/pr-review.md similarity index 100% rename from src/beeware_docs_tools/shared_content/en/contribute/next/pr-review.md rename to src/beeware_docs_tools/shared_content/en/_shared/contribute/next/pr-review.md diff --git a/src/beeware_docs_tools/shared_content/en/contribute/next/release.md b/src/beeware_docs_tools/shared_content/en/_shared/contribute/next/release.md similarity index 100% rename from src/beeware_docs_tools/shared_content/en/contribute/next/release.md rename to src/beeware_docs_tools/shared_content/en/_shared/contribute/next/release.md diff --git a/src/beeware_docs_tools/shared_content/en/contribute/policies/ai-policy.md b/src/beeware_docs_tools/shared_content/en/_shared/contribute/policies/ai-policy.md similarity index 100% rename from src/beeware_docs_tools/shared_content/en/contribute/policies/ai-policy.md rename to src/beeware_docs_tools/shared_content/en/_shared/contribute/policies/ai-policy.md diff --git a/src/beeware_docs_tools/shared_content/en/contribute/style/code-style-guide.md b/src/beeware_docs_tools/shared_content/en/_shared/contribute/style/code-style-guide.md similarity index 100% rename from src/beeware_docs_tools/shared_content/en/contribute/style/code-style-guide.md rename to src/beeware_docs_tools/shared_content/en/_shared/contribute/style/code-style-guide.md diff --git a/src/beeware_docs_tools/shared_content/en/contribute/style/docs-style-guide.md b/src/beeware_docs_tools/shared_content/en/_shared/contribute/style/docs-style-guide.md similarity index 100% rename from src/beeware_docs_tools/shared_content/en/contribute/style/docs-style-guide.md rename to src/beeware_docs_tools/shared_content/en/_shared/contribute/style/docs-style-guide.md diff --git a/src/beeware_docs_tools/shared_content/en/contribute/what/fix-issue.md b/src/beeware_docs_tools/shared_content/en/_shared/contribute/what/fix-issue.md similarity index 87% rename from src/beeware_docs_tools/shared_content/en/contribute/what/fix-issue.md rename to src/beeware_docs_tools/shared_content/en/_shared/contribute/what/fix-issue.md index 108fad9b..ced4c1d5 100644 --- a/src/beeware_docs_tools/shared_content/en/contribute/what/fix-issue.md +++ b/src/beeware_docs_tools/shared_content/en/_shared/contribute/what/fix-issue.md @@ -12,19 +12,19 @@ Even if you can't fix the problem, reporting anything you discover during the pr /// details-abstract | Set up a development environment -{% include "how-to/contribute/how/dev-environment.md" %} +{% include "how/dev-environment.md" %} /// /// details-abstract | Work from a branch -{% include "how-to/contribute/how/branches.md" %} +{% include "how/branches.md" %} /// /// details-abstract | Reproduce the issue -{% include "how-to/contribute/how/reproduce-issue.md" %} +{% include "how/reproduce-issue.md" %} /// @@ -32,7 +32,7 @@ Even if you can't fix the problem, reporting anything you discover during the pr /// details-abstract | Write, run, and test code -{% include "how-to/contribute/how/write-code.md" %} +{% include "how/write-code.md" %} /// @@ -40,13 +40,13 @@ Even if you can't fix the problem, reporting anything you discover during the pr /// details-abstract | Build documentation -{% include "how-to/contribute/how/build-docs.md" %} +{% include "how/build-docs.md" %} /// /// details-abstract | Write documentation -{% include "how-to/contribute/how/write-docs.md" %} +{% include "how/write-docs.md" %} /// @@ -54,12 +54,12 @@ Even if you can't fix the problem, reporting anything you discover during the pr /// details-abstract | Add a change note -{% include "how-to/contribute/how/change-note.md" %} +{% include "how/change-note.md" %} /// /// details-abstract | Submit a pull request -{% include "how-to/contribute/how/submit-pr.md" %} +{% include "how/submit-pr.md" %} /// diff --git a/src/beeware_docs_tools/shared_content/en/contribute/what/implement-feature.md b/src/beeware_docs_tools/shared_content/en/_shared/contribute/what/implement-feature.md similarity index 78% rename from src/beeware_docs_tools/shared_content/en/contribute/what/implement-feature.md rename to src/beeware_docs_tools/shared_content/en/_shared/contribute/what/implement-feature.md index a18982b1..b2f6c002 100644 --- a/src/beeware_docs_tools/shared_content/en/contribute/what/implement-feature.md +++ b/src/beeware_docs_tools/shared_content/en/_shared/contribute/what/implement-feature.md @@ -15,48 +15,48 @@ An important part of implementing a new feature is ensuring that feature is full /// details-abstract | Set up a development environment -{% include "how-to/contribute/how/dev-environment.md" %} +{% include "how/dev-environment.md" %} /// /// details-abstract | Work from a branch -{% include "how-to/contribute/how/branches.md" %} +{% include "how/branches.md" %} /// /// details-abstract | Avoid scope creep -{% include "how-to/contribute/how/scope-creep.md" %} +{% include "how/scope-creep.md" %} /// /// details-abstract | Implement the new feature -{% include "how-to/contribute/how/write-code.md" %} +{% include "how/write-code.md" %} /// /// details-abstract | Build documentation -{% include "how-to/contribute/how/build-docs.md" %} +{% include "how/build-docs.md" %} /// /// details-abstract | Write documentation -{% include "how-to/contribute/how/write-docs.md" %} +{% include "how/write-docs.md" %} /// /// details-abstract | Add a change note -{% include "how-to/contribute/how/change-note.md" %} +{% include "how/change-note.md" %} /// /// details-abstract | Submit a pull request -{% include "how-to/contribute/how/submit-pr.md" %} +{% include "how/submit-pr.md" %} /// diff --git a/src/beeware_docs_tools/shared_content/en/contribute/what/propose-feature.md b/src/beeware_docs_tools/shared_content/en/_shared/contribute/what/propose-feature.md similarity index 98% rename from src/beeware_docs_tools/shared_content/en/contribute/what/propose-feature.md rename to src/beeware_docs_tools/shared_content/en/_shared/contribute/what/propose-feature.md index d82a76f0..6d7952dd 100644 --- a/src/beeware_docs_tools/shared_content/en/contribute/what/propose-feature.md +++ b/src/beeware_docs_tools/shared_content/en/_shared/contribute/what/propose-feature.md @@ -38,6 +38,6 @@ If you're unsure about any of this, don't worry! Submit your idea, and let us kn /// details-abstract | Proposing a new feature -{% include "how-to/contribute/how/propose-feature.md" %} +{% include "how/propose-feature.md" %} /// diff --git a/src/beeware_docs_tools/shared_content/en/contribute/what/review-pr.md b/src/beeware_docs_tools/shared_content/en/_shared/contribute/what/review-pr.md similarity index 96% rename from src/beeware_docs_tools/shared_content/en/contribute/what/review-pr.md rename to src/beeware_docs_tools/shared_content/en/_shared/contribute/what/review-pr.md index 5a9a6922..fe826a80 100644 --- a/src/beeware_docs_tools/shared_content/en/contribute/what/review-pr.md +++ b/src/beeware_docs_tools/shared_content/en/_shared/contribute/what/review-pr.md @@ -16,6 +16,6 @@ As a first-time contributor, you should feel free to review any pull request you /// details-abstract | Providing a pull request review -{% include "how-to/contribute/how/review-pr.md" %} +{% include "how/review-pr.md" %} /// diff --git a/src/beeware_docs_tools/shared_content/en/contribute/what/translate.md b/src/beeware_docs_tools/shared_content/en/_shared/contribute/what/translate.md similarity index 95% rename from src/beeware_docs_tools/shared_content/en/contribute/what/translate.md rename to src/beeware_docs_tools/shared_content/en/_shared/contribute/what/translate.md index 48bd86e6..7781a91e 100644 --- a/src/beeware_docs_tools/shared_content/en/contribute/what/translate.md +++ b/src/beeware_docs_tools/shared_content/en/_shared/contribute/what/translate.md @@ -10,6 +10,6 @@ We use [DeepL](https://www.deepl.com/en/translator) for machine translation to p /// details-abstract | Translate content -{% include "how-to/contribute/how/translate.md" %} +{% include "how/translate.md" %} /// diff --git a/src/beeware_docs_tools/shared_content/en/contribute/what/triage.md b/src/beeware_docs_tools/shared_content/en/_shared/contribute/what/triage.md similarity index 94% rename from src/beeware_docs_tools/shared_content/en/contribute/what/triage.md rename to src/beeware_docs_tools/shared_content/en/_shared/contribute/what/triage.md index 535d90dd..b21e1338 100644 --- a/src/beeware_docs_tools/shared_content/en/contribute/what/triage.md +++ b/src/beeware_docs_tools/shared_content/en/_shared/contribute/what/triage.md @@ -8,6 +8,6 @@ Triaging an issue does not mean you are expected to fix it. Depending on the iss /// details-abstract | Reproduce the issue -{% include "how-to/contribute/how/reproduce-issue.md" %} +{% include "how/reproduce-issue.md" %} /// diff --git a/src/beeware_docs_tools/shared_content/en/contribute/what/use-tools.md b/src/beeware_docs_tools/shared_content/en/_shared/contribute/what/use-tools.md similarity index 90% rename from src/beeware_docs_tools/shared_content/en/contribute/what/use-tools.md rename to src/beeware_docs_tools/shared_content/en/_shared/contribute/what/use-tools.md index e2764250..86dd6b38 100644 --- a/src/beeware_docs_tools/shared_content/en/contribute/what/use-tools.md +++ b/src/beeware_docs_tools/shared_content/en/_shared/contribute/what/use-tools.md @@ -10,12 +10,12 @@ If you do experience any problems, start a new discussion topic, as it may be th /// details-abstract | Submit a new issue -{% include "how-to/contribute/how/new-issue.md" %} +{% include "how/new-issue.md" %} /// /// details-abstract | Propose a new feature -{% include "how-to/contribute/how/propose-feature.md" %} +{% include "how/propose-feature.md" %} /// diff --git a/src/beeware_docs_tools/shared_content/en/contribute/what/write-docs.md b/src/beeware_docs_tools/shared_content/en/_shared/contribute/what/write-docs.md similarity index 93% rename from src/beeware_docs_tools/shared_content/en/contribute/what/write-docs.md rename to src/beeware_docs_tools/shared_content/en/_shared/contribute/what/write-docs.md index 8fbc67be..7db47ed0 100644 --- a/src/beeware_docs_tools/shared_content/en/contribute/what/write-docs.md +++ b/src/beeware_docs_tools/shared_content/en/_shared/contribute/what/write-docs.md @@ -49,48 +49,48 @@ A reference guide in baking might describe the types of sugar that could be used /// details-abstract | Proposing new documentation -{% include "how-to/contribute/how/propose-feature.md" %} +{% include "how/propose-feature.md" %} /// /// details-abstract | Set up a development environment -{% include "how-to/contribute/how/dev-environment.md" %} +{% include "how/dev-environment.md" %} /// /// details-abstract | Work from a branch -{% include "how-to/contribute/how/branches.md" %} +{% include "how/branches.md" %} /// /// details-abstract | Avoid scope creep -{% include "how-to/contribute/how/scope-creep.md" %} +{% include "how/scope-creep.md" %} /// /// details-abstract | Building documentation -{% include "how-to/contribute/how/build-docs.md" %} +{% include "how/build-docs.md" %} /// /// details-abstract | Writing documentation -{% include "how-to/contribute/how/write-docs.md" %} +{% include "how/write-docs.md" %} /// /// details-abstract | Add a change note -{% include "how-to/contribute/how/change-note.md" %} +{% include "how/change-note.md" %} /// /// details-abstract | Submit a pull request -{% include "how-to/contribute/how/submit-pr.md" %} +{% include "how/submit-pr.md" %} /// From 7ceaf76a0b75dbe8375cc54c40602425e8ee2169 Mon Sep 17 00:00:00 2001 From: Kattni Date: Wed, 3 Jun 2026 00:10:33 -0400 Subject: [PATCH 4/5] Revert SUMMARY.md. --- docs/en/SUMMARY.md | 73 +++++++++++++++++++++++----------------------- 1 file changed, 37 insertions(+), 36 deletions(-) diff --git a/docs/en/SUMMARY.md b/docs/en/SUMMARY.md index 23dae629..21ed34eb 100644 --- a/docs/en/SUMMARY.md +++ b/docs/en/SUMMARY.md @@ -9,39 +9,40 @@ search: - [Section two](section_two/index.md) - [Section three](section_three/index.md) - ./section_three/* -- [Shared content testbed](content_test_bed/index.md) - - How-to guides - - [Contribute](content_test_bed/how-to/contribute/index.md) - - [Contributing](content_test_bed/how-to/contribute/index.md) - - [First-time contributors](content_test_bed/how-to/contribute/first-time-contributors.md) - - What can I do? - - [Fix an issue](content_test_bed/how-to/contribute/what/fix-issue.md) - - [Implement a new feature](content_test_bed/how-to/contribute/what/implement-feature.md) - - [Write documentation](content_test_bed/how-to/contribute/what/write-docs.md) - - [Triage an issue](content_test_bed/how-to/contribute/what/triage.md) - - [Review a pull request](content_test_bed/how-to/contribute/what/review-pr.md) - - [Propose a new feature](content_test_bed/how-to/contribute/what/propose-feature.md) - - [Translate content](content_test_bed/how-to/contribute/what/translate.md) - - [Use the tools](content_test_bed/how-to/contribute/what/use-tools.md) - - How do I contribute? - - [Setting up a development environment](content_test_bed/how-to/contribute/how/dev-environment.md) - - [Reproducing an issue](content_test_bed/how-to/contribute/how/reproduce-issue.md) - - [Working from a branch](content_test_bed/how-to/contribute/how/branches.md) - - [Avoiding scope creep](content_test_bed/how-to/contribute/how/scope-creep.md) - - [Writing, running, and testing code](content_test_bed/how-to/contribute/how/write-code.md) - - [Building documentation](content_test_bed/how-to/contribute/how/build-docs.md) - - [Writing documentation](content_test_bed/how-to/contribute/how/write-docs.md) - - [Adding a change note](content_test_bed/how-to/contribute/how/change-note.md) - - [Submitting a pull request](content_test_bed/how-to/contribute/how/submit-pr.md) - - [Providing a review](content_test_bed/how-to/contribute/how/review-pr.md) - - [Submitting a new issue](content_test_bed/how-to/contribute/how/new-issue.md) - - [Proposing a new feature](content_test_bed/how-to/contribute/how/propose-feature.md) - - [Translating content](content_test_bed/how-to/contribute/how/translate.md) - - What happens next? - - [Pull request review process](content_test_bed/how-to/contribute/next/pr-review.md) - - [Release process](content_test_bed/how-to/contribute/next/release.md) - - Policies - - [AI Policy](content_test_bed/how-to/contribute/policies/ai-policy.md) - - Style guides - - [Code style guide](content_test_bed/how-to/contribute/style/code-style-guide.md) - - [Documentation style guide](content_test_bed/how-to/contribute/style/docs-style-guide.md) +- Shared content testbed + - [Shared content testbed](content_test_bed/index.md) + - How-to guides + - Contribute + - [Contributing](content_test_bed/how-to/contribute/index.md) + - [First-time contributors](content_test_bed/how-to/contribute/first-time-contributors.md) + - What can I do? + - [Fix an issue](content_test_bed/how-to/contribute/what/fix-issue.md) + - [Implement a new feature](content_test_bed/how-to/contribute/what/implement-feature.md) + - [Write documentation](content_test_bed/how-to/contribute/what/write-docs.md) + - [Triage an issue](content_test_bed/how-to/contribute/what/triage.md) + - [Review a pull request](content_test_bed/how-to/contribute/what/review-pr.md) + - [Propose a new feature](content_test_bed/how-to/contribute/what/propose-feature.md) + - [Translate content](content_test_bed/how-to/contribute/what/translate.md) + - [Use the tools](content_test_bed/how-to/contribute/what/use-tools.md) + - How do I contribute? + - [Setting up a development environment](content_test_bed/how-to/contribute/how/dev-environment.md) + - [Reproducing an issue](content_test_bed/how-to/contribute/how/reproduce-issue.md) + - [Working from a branch](content_test_bed/how-to/contribute/how/branches.md) + - [Avoiding scope creep](content_test_bed/how-to/contribute/how/scope-creep.md) + - [Writing, running, and testing code](content_test_bed/how-to/contribute/how/write-code.md) + - [Building documentation](content_test_bed/how-to/contribute/how/build-docs.md) + - [Writing documentation](content_test_bed/how-to/contribute/how/write-docs.md) + - [Adding a change note](content_test_bed/how-to/contribute/how/change-note.md) + - [Submitting a pull request](content_test_bed/how-to/contribute/how/submit-pr.md) + - [Providing a review](content_test_bed/how-to/contribute/how/review-pr.md) + - [Submitting a new issue](content_test_bed/how-to/contribute/how/new-issue.md) + - [Proposing a new feature](content_test_bed/how-to/contribute/how/propose-feature.md) + - [Translating content](content_test_bed/how-to/contribute/how/translate.md) + - What happens next? + - [Pull request review process](content_test_bed/how-to/contribute/next/pr-review.md) + - [Release process](content_test_bed/how-to/contribute/next/release.md) + - Policies + - [AI Policy](content_test_bed/how-to/contribute/policies/ai-policy.md) + - Style guides + - [Code style guide](content_test_bed/how-to/contribute/style/code-style-guide.md) + - [Documentation style guide](content_test_bed/how-to/contribute/style/docs-style-guide.md) From 667c43b67ff954b1a899de63ba2349da6b045812 Mon Sep 17 00:00:00 2001 From: Kattni Date: Wed, 3 Jun 2026 22:07:00 -0400 Subject: [PATCH 5/5] CSS and remove website content. --- .../overrides/assets/stylesheets/beeware_theme.css | 5 +++++ .../en/_shared/contribute/how/dev-environment.md | 13 ------------- 2 files changed, 5 insertions(+), 13 deletions(-) diff --git a/src/beeware_docs_tools/overrides/assets/stylesheets/beeware_theme.css b/src/beeware_docs_tools/overrides/assets/stylesheets/beeware_theme.css index 6687c045..ee62aa0d 100644 --- a/src/beeware_docs_tools/overrides/assets/stylesheets/beeware_theme.css +++ b/src/beeware_docs_tools/overrides/assets/stylesheets/beeware_theme.css @@ -653,3 +653,8 @@ footer.md-footer *, html .md-footer-meta.md-typeset a { .md-typeset table:not([class]) { font-size: 1rem; } + +/* Remove H1 from collapsed content */ +details.abstract h1 { + display: none; +} diff --git a/src/beeware_docs_tools/shared_content/en/_shared/contribute/how/dev-environment.md b/src/beeware_docs_tools/shared_content/en/_shared/contribute/how/dev-environment.md index 814b0ac2..1aa95507 100644 --- a/src/beeware_docs_tools/shared_content/en/_shared/contribute/how/dev-environment.md +++ b/src/beeware_docs_tools/shared_content/en/_shared/contribute/how/dev-environment.md @@ -1,14 +1,3 @@ - -{% if config.extra.website %} - -Contributing to BeeWare requires you to pick a project and set up a development environment: - -* [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/) - -{% else %} - Contributing to {{ formal_name }} requires you to set up a development environment. ### Prerequisites { #dev-environment-prereqs } @@ -315,6 +304,4 @@ pre-commit installed at .git/hooks/pre-commit {% endif %} -{% endif %} - Now you are ready to start hacking on {{ formal_name }}!