render-engine 2026.1.1a2__tar.gz → 2026.2.1a1__tar.gz

{render_engine-2026.1.1a2 → render_engine-2026.2.1a1}/.github/workflows/lint.yml

@@ -35,15 +35,6 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v6.0.1
-      - name: Markdown Lint base-files
-        uses: DavidAnson/markdownlint-cli2-action@v20
-        with:
-          globs: |
-            *.md
-            .github/**/*.md
-          config: ./.markdownlint.json
-      - name: Markdown Lint Docs
-        uses: DavidAnson/markdownlint-cli2-action@v20
-        with:
-          globs: docs/**/*.md
-          config: docs/.markdownlint.json
+      - uses: oven-sh/setup-bun@v2
+      - name: Lint files
+        run: bunx markdownlint-cli2 **/*.md

{render_engine-2026.1.1a2 → render_engine-2026.2.1a1}/.github/workflows/test.yml

@@ -14,6 +14,27 @@ on:
       - "requirements.txt"
 
 jobs:
+  gen-coverage-badge:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - uses: astral-sh/setup-uv@v7
+        with:
+          python-version: "3.14"
+          enable-cache: true
+
+      - name: run coverage and generate cov-report
+        run: |
+          uv run --dev pytest --cov-report xml
+      - name: genbadge coverage
+        run: |
+          uvx --with "genbadge[coverage]" genbadge coverage -i coverage.xml
+      - name: Commit Badge
+        uses: stefanzweifel/git-auto-commit-action@v7
+        with:
+          commit_message: Update coverage badge [skip ci]
+          file_pattern: coverage.svg
+
   test-against-python-matrix:
     # Only test all the supported versions when a pull request is made or the workflow is called
     if: ${{github.event_name == 'workflow_call'}} || ${{github.event_name == 'pull_request'}}
@@ -24,16 +45,14 @@ jobs:
       fail-fast: true
     steps:
       - uses: actions/checkout@v6.0.1
-      - uses: actions/setup-python@v5
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
         with:
           python-version: ${{ matrix.python-version }}
-          cache: "pip" # caching pip dependencies
-      - name: Install requirements
-        run: |
-          python -m pip install -e .[dev]
+          enable-cache: true # caching dependencies
       - name: Run tests
         run: |
-          python -m pytest
+          uv run --dev pytest tests
 
   test-against-latest-os:
     # Always run against the latest version on both Windows, Linux, MacOS
@@ -45,19 +64,10 @@ jobs:
     runs-on: ${{ matrix.os }}
     steps:
       - uses: actions/checkout@v6.0.1
-      - uses: actions/setup-python@v5
-        with:
-          python-version: "3.12"
-          cache: "pip" # caching pip dependencies
-      - name: Install requirements
-        run: |
-          python -m pip install -e .[dev]
-      - name: Run tests
-        run: |
-          python -m pytest
-      - name: coverage
-        uses: actions/upload-artifact@v6
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
         with:
-          name: code-coverage-report-${{ matrix.os }}
-          path: .coverage
-          overwrite: true
+          python-version: "3.14"
+          enable-cache: true # caching dependencies
+      - name: run tests
+        run: uv run --dev pytest tests

render_engine-2026.2.1a1/.github/workflows/ty.yml

@@ -0,0 +1,22 @@
+name: Type Check
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+        - main
+    paths:
+      - "src/**"
+      - "pyproject.toml"
+  workflow_dispatch:
+
+jobs:
+  ty_check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6.0.1
+      - uses: astral-sh/setup-uv@v7
+      - name: Run type (ty) check
+        run: uv run ty check src

render_engine-2026.2.1a1/.github/workflows/update-security.yml

@@ -0,0 +1,62 @@
+name: Update SECURITY.md
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  update-security:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v6.0.1
+        with:
+          ref: main
+
+      - name: Get latest release version
+        id: get_version
+        run: |
+          VERSION="${{ github.event.release.tag_name }}"
+          echo "version=$VERSION" >> $GITHUB_OUTPUT
+
+      - name: Update SECURITY.md
+        run: |
+          VERSION="${{ steps.get_version.outputs.version }}"
+          # Update SECURITY.md with properly formatted table
+          cat >SECURITY.md <<EOF
+          # Security Policy
+
+          ## Supported Versions
+
+          We only support the latest version of render-engine with security updates.
+          Please ensure you are using the most recent release available on PyPI or GitHub.
+
+          | Version       | Supported          |
+          | ------------- | ------------------ |
+          | {{ VERSION }}     | :white_check_mark: |
+          | < {{ VERSION }}  | :x:                |
+
+          ## Reporting a Vulnerability
+
+          Email: <kjaymiller@gmail.com>
+          EOF
+
+      - name: Check for changes
+        id: check_changes
+        run: |
+          if git diff --quiet SECURITY.md; then
+            echo "changed=false" >> $GITHUB_OUTPUT
+          else
+            echo "changed=true" >> $GITHUB_OUTPUT
+          fi
+
+      - name: Commit and push changes
+        if: steps.check_changes.outputs.changed == 'true'
+        run: |
+          git config --local user.email "github-actions[bot]@users.noreply.github.com"
+          git config --local user.name "github-actions[bot]"
+          git add SECURITY.md
+          git commit -m "Update SECURITY.md to version ${{ steps.get_version.outputs.version }}"
+          git push

render_engine-2026.2.1a1/.markdownlint.json

@@ -0,0 +1,8 @@
+{
+  "MD013": {
+    "line_length": 120,
+    "tables": false,
+    "code_blocks": false
+  },
+  "MD041": false
+}

render_engine-2026.2.1a1/.readthedocs.yml

@@ -0,0 +1,24 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-lts-latest
+  tools:
+    python: "latest"
+  jobs:
+    pre_create_environment:
+        - asdf plugin add uv
+        - asdf install uv latest
+        - asdf global uv latest
+    create_environment:
+        - uv venv "${READTHEDOCS_VIRTUALENV_PATH}"
+    install:
+        - UV_PROJECT_ENVIRONMENT="${READTHEDOCS_VIRTUALENV_PATH}" uv sync --group docs
+
+mkdocs:
+  configuration: docs/mkdocs.yml

{render_engine-2026.1.1a2 → render_engine-2026.2.1a1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: render_engine
-Version: 2026.1.1a2
+Version: 2026.2.1a1
 Summary: A Flexible Static Site Generator for Python
 Project-URL: homepage, https://github.com/render-engine/render-engine/
 Project-URL: repository, https://github.com/render-engine/render-engine/
@@ -21,22 +21,6 @@ Provides-Extra: cli
 Requires-Dist: render-engine-cli; extra == "cli"
 Provides-Extra: extras
 Requires-Dist: render-engine-sitemap; extra == "extras"
-Provides-Extra: dev
-Requires-Dist: cookiecutter; extra == "dev"
-Requires-Dist: ephemeral-port-reserve; extra == "dev"
-Requires-Dist: httpx; extra == "dev"
-Requires-Dist: mkdocs; extra == "dev"
-Requires-Dist: mkdocs-material; extra == "dev"
-Requires-Dist: mkdocstrings[python]; extra == "dev"
-Requires-Dist: mypy; extra == "dev"
-Requires-Dist: pre-commit; extra == "dev"
-Requires-Dist: pymdown-extensions; extra == "dev"
-Requires-Dist: pytest; extra == "dev"
-Requires-Dist: pytest-cov; extra == "dev"
-Requires-Dist: pytest-mock; extra == "dev"
-Requires-Dist: ruff; extra == "dev"
-Requires-Dist: toml; extra == "dev"
-Requires-Dist: watchfiles; extra == "dev"
 
 <!-- markdownlint-disable -->
 <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
@@ -47,6 +31,7 @@ Requires-Dist: watchfiles; extra == "dev"
 # Render Engine
 
 [![PyTest](https://github.com/kjaymiller/render_engine/actions/workflows/test.yml/badge.svg)](https://github.com/kjaymiller/render_engine/actions/workflows/test.yml)
+![genbadge-coverage](./coverage-badge.svg)
 [![Discord](https://img.shields.io/discord/1174377880118104156?label=Discord&color=purple)](https://discord.gg/2xMQ4j4d8m)
 
 ## Learn More
@@ -59,9 +44,12 @@ Requires-Dist: watchfiles; extra == "dev"
 
 ## The _3 layer_ Architecture
 
-- **[Page](https://render-engine.readthedocs.io/en/latest/page/)** - A single webpage item built from content, a template, raw data, or a combination of those things.
-- **[Collection](https://render-engine.readthedocs.io/en/latest/collection/)** - A group of webpages built from the same template, organized in a single directory
-- **[Site](https://render-engine.readthedocs.io/en/latest/site/)** - The container that helps to render all Pages and Collections with uniform settings and variables
+- **[Page][page-docs]** - A single webpage item built from content, a template,
+  raw data, or a combination of those things.
+- **[Collection][collection-docs]** - A group of webpages built from the same
+  template, organized in a single directory
+- **[Site][site-docs]** - The container that helps to render all Pages and
+  Collections with uniform settings and variables
 
 ## Installing Render Engine
 
@@ -88,13 +76,20 @@ Check out the [Getting Started](https://render-engine.readthedocs.io/en/latest/p
 
 ## Finding Awesome Add-Ons
 
-We've compiled a set of [awesome add-ons](https://github.com/render-engine/render-engine-awesome-list) that you can use to make your site even better!
+We've compiled a set of [awesome add-ons][awesome-list] that you can use to
+make your site even better!
+
+## CONTRIBUTING
+
+We encourage contributors of all skill levels.
+Please review the [contributing][contributing] section of our docs for more information.
 
 ## Contributors
 
+<!-- markdownlint-disable -->
 <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
 <!-- prettier-ignore-start -->
-<!-- markdownlint-disable -->
+
 <table>
   <tbody>
     <tr>
@@ -126,20 +121,18 @@ We've compiled a set of [awesome add-ons](https://github.com/render-engine/rende
   </tbody>
 </table>
 
-<!-- markdownlint-restore -->
 <!-- prettier-ignore-end -->
-
 <!-- ALL-CONTRIBUTORS-LIST:END -->
-<!-- prettier-ignore-start -->
-<!-- markdownlint-disable -->
-
 <!-- markdownlint-restore -->
-<!-- prettier-ignore-end -->
-
-<!-- ALL-CONTRIBUTORS-LIST:END -->
 
 ### Sponsors at the $20/month and Higher Level
 
 - [Brian Douglas](https://github.com/bdougie)
 
 Thank you to them and all of those who continue to support this project!
+
+[contributing]: https://render-engine.readthedocs.io/en/latest/contributing/CONTRIBUTING/
+[page-docs]: https://render-engine.readthedocs.io/en/latest/page/
+[collection-docs]: https://render-engine.readthedocs.io/en/latest/collection/
+[site-docs]: https://render-engine.readthedocs.io/en/latest/site/
+[awesome-list]: https://github.com/render-engine/render-engine-awesome-list

{render_engine-2026.1.1a2 → render_engine-2026.2.1a1}/README.md

@@ -7,6 +7,7 @@
 # Render Engine
 
 [![PyTest](https://github.com/kjaymiller/render_engine/actions/workflows/test.yml/badge.svg)](https://github.com/kjaymiller/render_engine/actions/workflows/test.yml)
+![genbadge-coverage](./coverage-badge.svg)
 [![Discord](https://img.shields.io/discord/1174377880118104156?label=Discord&color=purple)](https://discord.gg/2xMQ4j4d8m)
 
 ## Learn More
@@ -19,9 +20,12 @@
 
 ## The _3 layer_ Architecture
 
-- **[Page](https://render-engine.readthedocs.io/en/latest/page/)** - A single webpage item built from content, a template, raw data, or a combination of those things.
-- **[Collection](https://render-engine.readthedocs.io/en/latest/collection/)** - A group of webpages built from the same template, organized in a single directory
-- **[Site](https://render-engine.readthedocs.io/en/latest/site/)** - The container that helps to render all Pages and Collections with uniform settings and variables
+- **[Page][page-docs]** - A single webpage item built from content, a template,
+  raw data, or a combination of those things.
+- **[Collection][collection-docs]** - A group of webpages built from the same
+  template, organized in a single directory
+- **[Site][site-docs]** - The container that helps to render all Pages and
+  Collections with uniform settings and variables
 
 ## Installing Render Engine
 
@@ -48,13 +52,20 @@ Check out the [Getting Started](https://render-engine.readthedocs.io/en/latest/p
 
 ## Finding Awesome Add-Ons
 
-We've compiled a set of [awesome add-ons](https://github.com/render-engine/render-engine-awesome-list) that you can use to make your site even better!
+We've compiled a set of [awesome add-ons][awesome-list] that you can use to
+make your site even better!
+
+## CONTRIBUTING
+
+We encourage contributors of all skill levels.
+Please review the [contributing][contributing] section of our docs for more information.
 
 ## Contributors
 
+<!-- markdownlint-disable -->
 <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
 <!-- prettier-ignore-start -->
-<!-- markdownlint-disable -->
+
 <table>
   <tbody>
     <tr>
@@ -86,20 +97,18 @@ We've compiled a set of [awesome add-ons](https://github.com/render-engine/rende
   </tbody>
 </table>
 
-<!-- markdownlint-restore -->
 <!-- prettier-ignore-end -->
-
 <!-- ALL-CONTRIBUTORS-LIST:END -->
-<!-- prettier-ignore-start -->
-<!-- markdownlint-disable -->
-
 <!-- markdownlint-restore -->
-<!-- prettier-ignore-end -->
-
-<!-- ALL-CONTRIBUTORS-LIST:END -->
 
 ### Sponsors at the $20/month and Higher Level
 
 - [Brian Douglas](https://github.com/bdougie)
 
 Thank you to them and all of those who continue to support this project!
+
+[contributing]: https://render-engine.readthedocs.io/en/latest/contributing/CONTRIBUTING/
+[page-docs]: https://render-engine.readthedocs.io/en/latest/page/
+[collection-docs]: https://render-engine.readthedocs.io/en/latest/collection/
+[site-docs]: https://render-engine.readthedocs.io/en/latest/site/
+[awesome-list]: https://github.com/render-engine/render-engine-awesome-list

render_engine-2026.2.1a1/SECURITY.md

@@ -0,0 +1,15 @@
+# Security Policy
+
+## Supported Versions
+
+We only support the latest version of render-engine with security updates.
+Please ensure you are using the most recent release available on PyPI or GitHub.
+
+| Version       | Supported          |
+| ------------- | ------------------ |
+| 2025.11.1     | :white_check_mark: |
+| < 2025.11.1   | :x:                |
+
+## Reporting a Vulnerability
+
+Email: <kjaymiller@gmail.com>

render_engine-2026.2.1a1/coverage-badge.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="114" height="20" role="img" aria-label="coverage: 91.87%"><title>coverage: 91.87%</title><linearGradient id="s" x2="0" y2="100%"><stop offset="0" stop-color="#bbb" stop-opacity=".1"/><stop offset="1" stop-opacity=".1"/></linearGradient><clipPath id="r"><rect width="114" height="20" rx="3" fill="#fff"/></clipPath><g clip-path="url(#r)"><rect width="61" height="20" fill="#555"/><rect x="61" width="53" height="20" fill="#4c1"/><rect width="114" height="20" fill="url(#s)"/></g><g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" text-rendering="geometricPrecision" font-size="110"><text aria-hidden="true" x="315" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="510">coverage</text><text x="315" y="140" transform="scale(.1)" fill="#fff" textLength="510">coverage</text><text aria-hidden="true" x="865" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="430">91.87%</text><text x="865" y="140" transform="scale(.1)" fill="#fff" textLength="430">91.87%</text></g></svg>

{render_engine-2026.1.1a2 → render_engine-2026.2.1a1}/docs/docs/archive.md

@@ -5,14 +5,15 @@ date: August 22, 2024
 tags: ["archive", "parameters", "collection"]
 ---
 
-Archives are a [`BasePage`](page.md?id=basepage) object used to display a list of [`Page`](page.md?id=page) objects in a [`Collection`](collection.md?id=collection).
+Archives are a [`BasePage`][basepage-object] object used to display a list of [`Page`][page-object] objects in a
+[`Collection`][collection-object].
 
 Archive objects create a customizable page that can be controlled via its parent Collection.
 
-Bases: [`BasePage`](page.md?id=basepage)
+Bases: [`BasePage`][basepage-object]
 
-The Archive is a [Page](page.md?id=page) object used by the collection
-that focuses on presenting the Collection's pages.
+The Archive is a [Page][page-object] object used by the collection that focuses on presenting the
+Collection's pages.
 
 **Parameters:**
 
@@ -20,7 +21,7 @@ that focuses on presenting the Collection's pages.
 
 | Name | Type | Description | Default |
 | ---- | ---- | ---- | ---- |
-| `pages` | `list[`[`BasePage`](page.md?id=basepage)`]` | The list of pages to include in the archive | _required_                                                |
+| `pages` | `list[`[`BasePage`][basepage-object]`]` | The list of pages to include in the archive | _required_ |
 | `title`         | `str`                                       | The title of the archive                                 | _required_                                                |
 | `template`      | `str                                        | Template`                                                | The template to use for the archive                       | "archive.html" |
 | `routes`        | `list[str                                   | Path]`                                                   | The routes for where the archive page should be generated | _required_     |
@@ -29,7 +30,7 @@ that focuses on presenting the Collection's pages.
 
 > !!! Warning Not Directly Used
     The Archive object is not meant to be used directly.
-    It is used by the [Collection](collection.md?id=collection) object.
+    It is used by the [Collection][collection-object] object.
     Attributes can be used to customize.
 
 Collection.archives yields a generator of Archive objects. Each Archive object will have a `pages` attribute that is a list of Page objects referenced in that Archive Page. The number of pages is determined by the `Collection.items_per_page` attribute.
@@ -74,3 +75,7 @@ Total Pages: {{num_of_pages}}
 <button{% if page_num == archive_index %}disabled{% endif%}>page_num</span>
 {% endfor %}
 ```
+
+[basepage-object]: page.md?id=basepage
+[page-object]: page.md?id=page
+[collection-object]: collection.md?id=collection

{render_engine-2026.1.1a2 → render_engine-2026.2.1a1}/docs/docs/cli.md

@@ -15,16 +15,8 @@ Render Engine comes with a CLI that can be used to create, build, and serve your
 
 ## pyproject.toml Configuration
 
-The Render Engine CLI can be configured through your `pyproject.toml` file to set default values and avoid repetitive command-line arguments.
-
-### Configuration Structure
-
-```toml
-[render-engine.cli]
-module = "your_module"
-site = "YourSiteClass"
-collection = "blog"  # optional
-```
+The Render Engine CLI can be configured through your `pyproject.toml` file to set default values and avoid
+repetitive command-line arguments.
 
 ### Configuration Options
 

{render_engine-2026.1.1a2 → render_engine-2026.2.1a1}/docs/docs/collection.md

@@ -56,7 +56,8 @@ content_manager_extras: dict[str, Any]: Configuration options to send to the `Co
 
 Returns a [Archive](archive.md) objects containing the pages from the `content_path`.
 
-Archives are an iterable and the individual pages are built shortly after the collection pages are built. This happens when [Site.render](site.md?id=render) is called.
+Archives are an iterable and the individual pages are built shortly after the collection pages are
+built. This happens when [Site.render][site-render] is called.
 
 ## Functions
 
@@ -74,7 +75,9 @@ You can access attributes from the `Collection` class inside all of its rendered
 
 To do so, you must create an attribute called `template_vars` and populate it with a dictionary of key:value pairs.
 
-In turn, each `Page` in the collection will have a `collection` attribute, similar to `Page.template_vars`. The dictionary includes any additional attributes you have defined within the `Collection` class.
+In turn, each `Page` in the collection will have a `collection` attribute, similar to
+`Page.template_vars`. The dictionary includes any additional attributes you have defined within the
+`Collection` class.
 
 ```python
 from render_engine import Site, Collection
@@ -103,6 +106,9 @@ Collection archives are a special type of page that is automatically generated f
 
 You can have archives generated by setting the `has_archive` to True.
 
-If you call `archives` from your collection and neither `has_archive` nor `items_per_page` is set, an error will be raised and an archive containing all pages will be generated.
+If you call `archives` from your collection and neither `has_archive` nor `items_per_page` is set,
+an error will be raised and an archive containing all pages will be generated.
 
 For more information, see [Collection Archives](archive.md).
+
+[site-render]: site.md?id=render

{render_engine-2026.1.1a2 → render_engine-2026.2.1a1}/docs/docs/content_manager.md

@@ -39,8 +39,8 @@ def create_entry(self, filepath: Path = None, editor: str = None, metadata: dict
 ### `pages`
 
 The `pages` property is how the `Collection` accesses its content. It is a method that _must_ be implemented by
-every `ContentManager`. An example `pages` implementation (from the
-[`FileContentManger`](https://github.com/render-engine/render-engine/blob/main/src/render_engine/content_managers/file_content_manager.py)) is:
+every `ContentManager`. An example `pages` implementation (from the [`FileContentManger`][file-content-manager])
+is:
 
 ```python
 @property
@@ -83,3 +83,5 @@ page: Page  # The Page to update
 content: str = None  # Updated content
 **kwargs: dict  # The other attributes for the updated page
 ```
+
+[file-content-manager]: https://github.com/render-engine/render-engine/blob/main/src/render_engine/content_managers/file_content_manager.py

{render_engine-2026.1.1a2 → render_engine-2026.2.1a1}/docs/docs/contributing/CONTRIBUTING.md

@@ -1,9 +1,11 @@
 # Contributing to Render Engine
 
-This document will help you get started in contributing to the Render Engine codebase is open source and contributions are welcome.
+This document will help you get started in contributing to the Render Engine codebase is open source and
+contributions are welcome.
 
 > **NOTE**
-> This is specifically for contributing to the Render-Engine package. For help with creating a plugin, custom parser or Theme. Please check the [Render Engine Wiki](https://github.com/render-engine/.github/wiki) or the [Render Engine Docs](https://render-engine.readthedocs.org).
+> This is specifically for contributing to the Render-Engine package. For help with creating a plugin, custom
+> parser or Theme. Please check the [Render Engine Wiki][wiki] or the [Render Engine Docs][docs].
 
 ## Docs
 
@@ -38,16 +40,17 @@ If you see or experience a problem, please file an issue. Include any important
 
 ## Wait to be Assigned Issues
 
-It's important to wait to be assigned an issue before starting to work on it. This prevents [working on code that won't be merged](https://render-engine.readthedocs.io/en/latest/contributing/CONTRIBUTING/#being-assigned-an-issue).
+It's important to wait to be assigned an issue before starting to work on it. This prevents
+[working on code that won't be merged][being-assigned].
 
 Comment _I can work on this_ or something to that effect, and wait for one of the maintainers to assign the issue to you.
 
 ## Setup your Environment
 
-Once you've been [assigned an issue](https://render-engine.readthedocs.io/en/latest/contributing/contributing#being-assigned-an-issue), you can begin working on an issue either locally with:
+Once you've been [assigned an issue][being-assigned], you can begin working on an issue either locally with:
 
-- [manual setup](https://render-engine.readthedocs.io/en/latest/contributing/environment_setup#developing-locally)
-- [dev container](https://render-engine.readthedocs.io/en/latest/contributing/environment_setup#developing-locally)/[GitHub Codespaces](https://render-engine.readthedocs.io/en/latest/contributing/environment_setup#using-codespaces).
+- [manual setup][manual-setup]
+- [dev container][dev-container]/[GitHub Codespaces][codespaces].
 - from dockerfile
 
 ### Manual Configuration
@@ -60,19 +63,21 @@ Once you've been [assigned an issue](https://render-engine.readthedocs.io/en/lat
 
 ### Dockerfile
 
-Our DevContainer is built primarily from a dockerfile. You can build from our Dockerfile directly which would ensure the manual configuration is ran (You will still need to fork and clone).
+Our DevContainer is built primarily from a dockerfile. You can build from our Dockerfile directly which would
+ensure the manual configuration is ran (You will still need to fork and clone).
 
 ## Verify Before Submitting
 
-Render Engine uses nox to text against all supported versions. PRs will not be approved without tests passing on all supported versions.
+Render Engine uses nox to text against all supported versions. PRs will not be approved without tests passing on
+all supported versions.
 
 - 🚫 changes aren't breaking existing code (failing tests)
 - 🚫 Ensure new dependencies are listed, justified, and approved to be added.
 
 ## Contributing to Documentation
 
-Render Engine uses [readthedocs](https://readthedocs.org) in combination with
-[MkDocs](https://www.mkdocs.org),[Material for MkDocs](https://squidfunk.github.io/mkdocs-material/), and [mkdocsstrings](https://mkdocsstrings.readthedocs.io/en/latest/) to generate documentation.
+Render Engine uses [readthedocs][readthedocs] in combination with [MkDocs][mkdocs],
+[Material for MkDocs][material], and [mkdocsstrings][mkdocsstrings] to generate documentation.
 
 - 📝 update docstrings for functions, methods, and classes.
 - 📷 add images and gifs where necessary. Assets should be stored in the `docs/docs/assets` folder.
@@ -93,3 +98,14 @@ If you're starting from a blank PR be sure to include the following:
 - issue(s)/discussions being addressed
 - Documentation or tests added/updated
 - Any follow up tasks pending
+
+[wiki]: https://github.com/render-engine/.github/wiki
+[docs]: https://render-engine.readthedocs.org
+[being-assigned]: https://render-engine.readthedocs.io/en/latest/contributing/CONTRIBUTING/#being-assigned-an-issue
+[manual-setup]: https://render-engine.readthedocs.io/en/latest/contributing/environment_setup#developing-locally
+[dev-container]: https://render-engine.readthedocs.io/en/latest/contributing/environment_setup#developing-locally
+[codespaces]: https://render-engine.readthedocs.io/en/latest/contributing/environment_setup#using-codespaces
+[readthedocs]: https://readthedocs.org
+[mkdocs]: https://www.mkdocs.org
+[material]: https://squidfunk.github.io/mkdocs-material/
+[mkdocsstrings]: https://mkdocsstrings.readthedocs.io/en/latest/