Skip to content

docs: restructure documentation layout#6

Merged
JacobCoffee merged 3 commits intomainfrom
docs-restructure
Nov 27, 2025
Merged

docs: restructure documentation layout#6
JacobCoffee merged 3 commits intomainfrom
docs-restructure

Conversation

@JacobCoffee
Copy link
Owner

@JacobCoffee JacobCoffee commented Nov 27, 2025

Summary

  • Rename async-python-debug-toolbar to debug-toolbar throughout codebase
  • Reorganize docs index with grid layout for screenshots
  • Create architecture/index.md for cleaner ADR navigation
  • Simplify API reference with quick navigation section
  • Use hidden toctrees with section captions (Learn, Reference, Architecture)
  • Match litestar-storages/workflows docs style

Changes

  • Updated README, CONTRIBUTING, pyproject.toml, docs/conf.py with correct repo name
  • docs/index.md: Grid layout for screenshots, cleaner feature list
  • docs/api/index.md: Quick navigation to key classes
  • docs/architecture/index.md: New index for architecture section
  • docs/comparison.md: Fixed repo name references

Test plan

  • make ci passes
  • Docs build successfully
  • Visual review of docs

🤖 Generated with Claude Code

@JacobCoffee @claude
docs: restructure documentation layout
52ffaf8 
- Rename async-python-debug-toolbar to debug-toolbar throughout
- Reorganize index with grid layout for screenshots
- Create architecture/index.md for cleaner ADR navigation
- Simplify API reference with quick navigation section
- Use hidden toctrees with section captions
- Match litestar-storages/workflows docs style

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings November 27, 2025 15:59
@github-actions
Copy link
Contributor

github-actions bot commented Nov 27, 2025 •
edited
Loading

PR Preview Action v1.6.3

🚀 View preview at
https://JacobCoffee.github.io/debug-toolbar/pr-preview/pr-6/

Built to branch gh-pages at 2025-11-27 16:21 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

Copilot AI reviewed Nov 27, 2025
View reviewed changes
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR renames the repository from async-python-debug-toolbar to debug-toolbar and modernizes the documentation structure to match the litestar-storages/workflows documentation style.

Key Changes:

  • Repository renamed throughout all documentation, configuration files, and URLs
  • Documentation index restructured with grid layout for visual screenshot gallery
  • New architecture index page for cleaner ADR navigation with grouped sections
  • API reference enhanced with quick navigation links to key classes

Reviewed changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated no comments.

Show a summary per file
File Description
pyproject.toml Updated all project URLs and changelog postprocessor to use new repository name
docs/index.md Restructured with grid layout for screenshots, hidden toctrees with captions, and streamlined feature list
docs/conf.py Updated GitHub URL in theme options
docs/comparison.md Updated all references from async-python-debug-toolbar to debug-toolbar
docs/architecture/index.md New index file for architecture section with organized ADR navigation
docs/architecture/ARCHITECTURE.md Updated repository directory name from async-python-debug-toolbar/ to debug-toolbar/
docs/api/index.md Added quick navigation section with links to core classes, Litestar integration, and panels
README.md Updated all GitHub URLs and documentation links to use new repository name
CONTRIBUTING.rst Updated clone URLs and issue tracker links to new repository name

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

JacobCoffee and others added 2 commits November 27, 2025 10:10
@JacobCoffee @claude
docs: flatten API reference structure
171e9d6 
- Replace recursive autosummary with manual API documentation
- Document each class with params, methods, and examples
- Remove deeply nested module tree in sidebar
- Match litestar-workflows API docs style

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
@JacobCoffee @claude
docs: put hero screenshot in card grid
adfd079 
🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings November 27, 2025 16:21
@JacobCoffee JacobCoffee merged commit cef8237 into main Nov 27, 2025
22 checks passed
@JacobCoffee JacobCoffee deleted the docs-restructure branch November 27, 2025 16:24
Copilot AI reviewed Nov 27, 2025
View reviewed changes
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 38 out of 38 changed files in this pull request and generated 8 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

docs/api/_autosummary/debug_toolbar.core.config.rst
@@ -1,4 +1,4 @@
debug\_toolbar.core.config
debug\_toolbar.core.config
Copy link

Copilot AI Nov 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This file contains a Unicode BOM (Byte Order Mark) character at the beginning. While it typically doesn't cause issues, it's generally best practice to avoid BOMs in UTF-8 files as they're unnecessary and can occasionally cause parsing issues with some tools. Consider saving these files without the BOM.

Suggested change
debug\_toolbar.core.config
debug\_toolbar.core.config

Copilot uses AI. Check for mistakes.
docs/api/_autosummary/debug_toolbar.core.context.rst
@@ -1,4 +1,4 @@
debug\_toolbar.core.context
debug\_toolbar.core.context
Copy link

Copilot AI Nov 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This file contains a Unicode BOM (Byte Order Mark) character at the beginning. While it typically doesn't cause issues, it's generally best practice to avoid BOMs in UTF-8 files as they're unnecessary and can occasionally cause parsing issues with some tools. Consider saving these files without the BOM.

Suggested change
debug\_toolbar.core.context
debug\_toolbar.core.context

Copilot uses AI. Check for mistakes.
docs/api/_autosummary/debug_toolbar.core.panel.rst
@@ -1,4 +1,4 @@
debug\_toolbar.core.panel
debug\_toolbar.core.panel
Copy link

Copilot AI Nov 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This file contains a Unicode BOM (Byte Order Mark) character at the beginning. While it typically doesn't cause issues, it's generally best practice to avoid BOMs in UTF-8 files as they're unnecessary and can occasionally cause parsing issues with some tools. Consider saving these files without the BOM.

Suggested change
debug\_toolbar.core.panel
debug\_toolbar.core.panel

Copilot uses AI. Check for mistakes.
docs/api/_autosummary/debug_toolbar.core.storage.rst
@@ -1,4 +1,4 @@
debug\_toolbar.core.storage
debug\_toolbar.core.storage
Copy link

Copilot AI Nov 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This file contains a Unicode BOM (Byte Order Mark) character at the beginning. While it typically doesn't cause issues, it's generally best practice to avoid BOMs in UTF-8 files as they're unnecessary and can occasionally cause parsing issues with some tools. Consider saving these files without the BOM.

Suggested change
debug\_toolbar.core.storage
debug\_toolbar.core.storage

Copilot uses AI. Check for mistakes.
docs/api/_autosummary/debug_toolbar.core.toolbar.rst
@@ -1,4 +1,4 @@
debug\_toolbar.core.toolbar
debug\_toolbar.core.toolbar
Copy link

Copilot AI Nov 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This file contains a Unicode BOM (Byte Order Mark) character at the beginning. While it typically doesn't cause issues, it's generally best practice to avoid BOMs in UTF-8 files as they're unnecessary and can occasionally cause parsing issues with some tools. Consider saving these files without the BOM.

Suggested change
debug\_toolbar.core.toolbar
debug\_toolbar.core.toolbar

Copilot uses AI. Check for mistakes.
docs/api/_autosummary/debug_toolbar.litestar.config.rst
@@ -1,4 +1,4 @@
debug\_toolbar.litestar.config
debug\_toolbar.litestar.config
Copy link

Copilot AI Nov 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This file contains a Unicode BOM (Byte Order Mark) character at the beginning. While it typically doesn't cause issues, it's generally best practice to avoid BOMs in UTF-8 files as they're unnecessary and can occasionally cause parsing issues with some tools. Consider saving these files without the BOM.

Suggested change
debug\_toolbar.litestar.config
debug\_toolbar.litestar.config

Copilot uses AI. Check for mistakes.
docs/api/_autosummary/debug_toolbar.litestar.middleware.rst
@@ -1,4 +1,4 @@
debug\_toolbar.litestar.middleware
debug\_toolbar.litestar.middleware
Copy link

Copilot AI Nov 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This file contains a Unicode BOM (Byte Order Mark) character at the beginning. While it typically doesn't cause issues, it's generally best practice to avoid BOMs in UTF-8 files as they're unnecessary and can occasionally cause parsing issues with some tools. Consider saving these files without the BOM.

Suggested change
debug\_toolbar.litestar.middleware
debug\_toolbar.litestar.middleware

Copilot uses AI. Check for mistakes.
docs/api/_autosummary/debug_toolbar.litestar.plugin.rst
@@ -1,4 +1,4 @@
debug\_toolbar.litestar.plugin
debug\_toolbar.litestar.plugin
Copy link

Copilot AI Nov 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This file contains a Unicode BOM (Byte Order Mark) character at the beginning. While it typically doesn't cause issues, it's generally best practice to avoid BOMs in UTF-8 files as they're unnecessary and can occasionally cause parsing issues with some tools. Consider saving these files without the BOM.

Suggested change
debug\_toolbar.litestar.plugin
debug\_toolbar.litestar.plugin

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@JacobCoffee