Skip to content

Automatically make documentation pages for Docassemble Interviews#593

Merged
nonprofittechy merged 2 commits intomainfrom
aldashboard_interview_docs
Mar 19, 2026
Merged

Automatically make documentation pages for Docassemble Interviews#593
nonprofittechy merged 2 commits intomainfrom
aldashboard_interview_docs

Conversation

@BryceStevenWilley
Copy link
Contributor

@BryceStevenWilley BryceStevenWilley commented Mar 6, 2026

Adds a short python script that generates documentation pages for docassemble interviews, with the main current target being the ALDashboard tool interviews.

Allows us to write markdown in a specific block marked with id: interview documentation, and have it make a page in the documentation (the next time it's generated). Links to the interview running on the dev server, and automatically makes a sidebar entry for it as well.

Example of a generated page below.

image

If added, gives us a way to address #250, by adding a page for each of the individual interviews.

Copy link
Member

@nonprofittechy nonprofittechy left a comment

Choose a reason for hiding this comment

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

See SuffolkLITLab/docassemble-ALDashboard#197 (comment)

I think it makes more sense just to pull the first block in a YAML file, if it is a comment, without expecting a specific ID.

@BryceStevenWilley BryceStevenWilley force-pushed the aldashboard_interview_docs branch from 43e2e80 to a91a2f4 Compare March 10, 2026 14:35
Copy link
Member

@nonprofittechy nonprofittechy left a comment

Choose a reason for hiding this comment

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

Sorry for delay--I don't get notified by GitHub on PR reviews. You can always ping me if I seem unusually slow.

@nonprofittechy nonprofittechy merged commit 77ef777 into main Mar 19, 2026
2 checks passed
@nonprofittechy nonprofittechy deleted the aldashboard_interview_docs branch March 19, 2026 18:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants