-
Notifications
You must be signed in to change notification settings - Fork 2
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add a landing page with the list of available demos to run #34
Comments
Agreed, good idea. Also we do have documentation for some of these here already: https://suffolklitlab.org/docassemble-AssemblyLine-documentation/docs/framework/altoolbox so maybe we link to that. But agreed it should be clear somewhere from just the repo where to go to learn more. @plocket suggested having a "package" YAML file for each interview to include (without any special extra name, just e.g., 3partsdate.yml), and then a _demo.yml to demonstrate the feature. That's a good convention for us to follow I think. |
Great, that page is a perfect place for the new link, and the landing page will complement it with a hands-on experience. Okay, for package file names we use one word like 3partsdate.yml. Question - If a module and a css are involved, it makes sense to have a "package" file; but if only a module is involved, having a package file doesn't seem to provide any "savings"? For demo file names, do we use underscore_lower_case_demo.yml? |
|
Yes, naming a demo as xxx_demo is always a good choice. Adding a package file when it's not called for would increase the number of files quickly. Alternatively, we could just add another convention:
I can add these rules to the landing page for ongoing additions. As for the existing ones, do we need to fix them (rename/delete), or just "list" them using the convention? I.e. use some functions to manipulate the display of the name? |
|
Motivations:
Question: do we need to have a name convention for the yml files? If so, should we fix the existing ones?
The text was updated successfully, but these errors were encountered: