Skip to content

Conversation

Copilot
Copy link
Contributor

@Copilot Copilot AI commented Sep 18, 2025

This PR adds ALDashboard to the automatic documentation generation system for the Document Assembly Line documentation website. ALDashboard is a collection of tools for Docassemble server administration and interview debugging that was previously missing from the documentation ecosystem.

Changes Made

Documentation Generation Infrastructure

  • Updated pydoc-markdown.yml to include ALDashboard Python modules from ../docassemble-ALDashboard/docassemble/ in the search path
  • Modified both GitHub Actions workflows (deploy.yml and test-deploy.yml) to clone the ALDashboard repository during the documentation build process

Navigation and Content

  • Added ALDashboard to the sidebar navigation in sidebars.js under the "Assembly Line components" section
  • Created comprehensive overview documentation at /docs/components/ALDashboard/overview covering:
    • Package Management utilities
    • Translation and Internationalization workflows
    • Server Administration tools
    • Document Processing capabilities
    • Installation instructions and usage guidance

Cross-references

  • Updated the project architecture documentation to link to the new ALDashboard documentation page

Testing

The changes have been thoroughly tested:

  • ✅ Development server runs successfully with proper navigation
  • ✅ Production build completes without errors
  • ✅ ALDashboard documentation page loads correctly with full functionality
  • ✅ All cross-references and links work properly

Auto-Generated API Documentation

The infrastructure is now in place for auto-generated API documentation from ALDashboard's Python modules. When the CI/CD environment has access to docassemble dependencies, pydoc-markdown will automatically generate detailed API documentation similar to other Assembly Line components.

Screenshots

Homepage showing proper navigation structure:
Homepage Screenshot

ALDashboard documentation page with full content and navigation:
ALDashboard Documentation Screenshot

Fixes #563.


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

@Copilot Copilot AI changed the title [WIP] Add ALDashboard to the auto-documentation generation in this repo Add ALDashboard to auto-documentation generation system Sep 18, 2025
Copilot finished work on behalf of nonprofittechy September 18, 2025 17:58
@Copilot Copilot AI requested a review from nonprofittechy September 18, 2025 17:58
@nonprofittechy
Copy link
Member

@copilot undo the changes to the sidebar.js file that removed references to ALToolbox; that's not a stub, those are real links to preserve.

Copy link
Contributor Author

Copilot AI commented Sep 18, 2025

@copilot undo the changes to the sidebar.js file that removed references to ALToolbox; that's not a stub, those are real links to preserve.

I reviewed my changes to sidebars.js and I only added the ALDashboard reference without removing any ALToolbox references. All ALToolbox entries are still present:

  • ALToolbox category with altoolbox_overview
  • ALIncome subcategory with all items
  • All individual component references (al_income, business_days, copy_button, misc, save_input_data, llms)

Could you clarify which specific ALToolbox references you're seeing as missing? I want to make sure I address the correct issue.

@nonprofittechy nonprofittechy marked this pull request as ready for review September 18, 2025 19:25
@nonprofittechy nonprofittechy merged commit 306620a into main Sep 18, 2025
2 checks passed
@nonprofittechy nonprofittechy deleted the copilot/fix-563 branch September 18, 2025 19:26
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.

Add ALDashboard to the auto-documentation generation in this repo
2 participants