SuffolkLITLab / docassemble-AssemblyLine-documentation

Legal form development and deployment process
https://assemblyline.suffolklitlab.org
9 stars 8 forks source link

ALKiln documentation should contain output you can copy and paste, not just point to the setup interview #347

Open nonprofittechy opened 1 year ago

nonprofittechy commented 1 year ago

Had a test that was written for ALKilnv2 that wasn't working, and the setup interview didn't work in that instance. The error isn't clear but I'm guessing because the files it was trying to write to already existed. But there's also no output you can copy and paste. Given that it's a boilerplate file it would probably be useful to include it right on the documentation page. Instead I got it by copying from an existing repo.

nonprofittechy commented 1 year ago

Discussing w/ @plocket and confirmed that:

  1. The file doesn't change per-interview or from choices in the setup interview, but it does change over time. So it's safe to have it listed verbatim somewhere
  2. It could go on the ALKiln advanced documentation page, and maybe also a help screen at the end or beginning of the setup interview if it's not too confusing
  3. Should we link to existing interviews that have it working so people can compare setup?
    • AssemblyLine
    • ALWeaver
    • MAEvictionDefense (if we get language tags working again), or the 209A