Skip to content

Add dedicated documentation page explaining the concept of backends#1597

Merged
nathanjmcdougall merged 5 commits intomainfrom
copilot/add-backend-concept-docs
Mar 30, 2026
Merged

Add dedicated documentation page explaining the concept of backends#1597
nathanjmcdougall merged 5 commits intomainfrom
copilot/add-backend-concept-docs

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Mar 27, 2026

  • Create a new docs/about/backends.md page explaining the concept of backends in usethis
  • Add the new page to the mkdocs.yml navigation under About
  • Cross-reference the new page from the FAQ where backends are already mentioned
  • Build the docs locally to verify rendering
  • Run static checks (prek, basedpyright — all pass)
  • Fix markdown formatting flagged by prek hooks (removed $ prompts in console blocks)

Resolves #1029


⌨️ Start Copilot coding agent tasks without leaving your editor — available in VS Code, Visual Studio, JetBrains IDEs and Eclipse.

Resolves the request to explain what a backend is in the docs, with a
dedicated .md file covering available backends (uv, none), auto-detection
logic, and CLI override options. Cross-references the new page from the FAQ.

Agent-Logs-Url: https://github.com/usethis-python/usethis-python/sessions/d365e391-1408-4d53-a8bc-1f51aaba015f

Co-authored-by: nathanjmcdougall <18602289+nathanjmcdougall@users.noreply.github.com>
Copilot AI changed the title [WIP] Add documentation explaining the concept of backend Add dedicated documentation page explaining the concept of backends Mar 27, 2026
Copilot AI requested a review from nathanjmcdougall March 27, 2026 10:21
@nathanjmcdougall nathanjmcdougall marked this pull request as ready for review March 27, 2026 10:30
@nathanjmcdougall nathanjmcdougall linked an issue Mar 28, 2026 that may be closed by this pull request
@nathanjmcdougall
Copy link
Copy Markdown
Collaborator

@copilot static checks are failing.

…locks)

Agent-Logs-Url: https://github.com/usethis-python/usethis-python/sessions/271ffe61-1893-433a-809b-b190dc7e7436

Co-authored-by: nathanjmcdougall <18602289+nathanjmcdougall@users.noreply.github.com>
Copy link
Copy Markdown
Contributor Author

Copilot AI commented Mar 28, 2026

@copilot static checks are failing.

Fixed in 7e034a4 — the $ prompt prefixes in console code blocks were being stripped by the markdownlint/prettier hooks. Removed them so prek passes cleanly.

@nathanjmcdougall nathanjmcdougall merged commit f742b96 into main Mar 30, 2026
11 checks passed
@nathanjmcdougall nathanjmcdougall deleted the copilot/add-backend-concept-docs branch March 30, 2026 00:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Explain the concept of what a backend is in the docs Provide better documenting regarding whether uv is necessary

2 participants