diff --git a/docs/get_started/beginners_guide.md b/docs/get_started/beginners_guide.md new file mode 100644 index 000000000..9db2d8eab --- /dev/null +++ b/docs/get_started/beginners_guide.md @@ -0,0 +1,61 @@ +--- +id: beginners_guide +title: Learn to Build Docassemble Interviews +sidebar_label: Beginner's Guide +slug: /get_started/beginners_guide +--- + +**If you have never used Docassemble before, you are on the right page!** This is how the [LIT Lab](https://suffolklitlab.org) teaches people to turn their first court form into a Docassemble guided interview. + +If you follow this guide you will be learning by doing. We want you to get started building your first interview as quickly as possible, and then the Document Assembly Line community can help you keep moving forward. + +Here are the steps: + +1. [Do the Hello, World exercise](#do-the-hello-world-exercise) for a friendly introduction to Docassemble +2. [Watch a demonstration of the Weaver](#watch-a-demonstration-of-the-weaver), a Document Assembly Line tool for quickly turning prepared forms into draft Docassemble interviews +3. [Join the Document Assembly Line community](#join-the-document-assembly-line-community) +4. [Start building your first interview!](#start-building-your-first-interview) + +:::tip +In order to build interviews you will need access to a [Docassemble playground](https://docassemble.org/docs/playground.html). But if you don't have one you can use ours! Register an account on the [LIT Lab Docassemble development server](https://apps-dev.suffolklitlab.org/user/register), then [email us](mailto:litlab@suffolk.edu) and ask for developer privileges. +::: + +## Do the Hello, World Exercise + +In his Legal Tech Class, Quinten Steenhuis introduces Docassemble with a [short "Hello, World" exercise](https://suffolklitlab.org/legal-tech-class/docs/classes/docacon-2020/hello-world). This introductory exercise is a great way to demystify Docassemble and see what it's like to build a simple interview—by actually doing it. + +**➡️ [Go to the Hello, World exercise.](https://suffolklitlab.org/legal-tech-class/docs/classes/docacon-2020/hello-world)** + +Once you have successfully completed the Hello, World exercise you might want to continue with the next few lessons in the Legal Tech Class to learn more about building interviews in Docassemble. + +When you have finished the Hello, World exercise, move on to the next step: learning about the Weaver. + +## Watch a Demonstration of the Weaver + +The Weaver is a Document Assembly Line tool that generates a draft Docassemble interview from a prepared PDF or DOCX form so you don't have to start from scratch. The best way to explain it is to see it in action: + + + +(The video should start playing from 26:35, which is when the demo starts.) + +The interview generated by the Weaver is not a finished interview. It is a starting point intended for further editing. + +Now you are probably itching to start building your first interview! But before you do, take a moment to review the interview-building workflow and join the Document Assembly Line community. + +## Join the Document Assembly Line Community + +You know enough to get started, but you will need help. The Document Assembly Line community meets weekly on Zoom for live support, and coding help is available 24/7 in our Microsoft Teams forum. + +**➡️ [Email us to join the Document Assembly Line community.](mailto:litlab@suffolk.edu)** + +You can also take advantage of other [interview building resources and documentation](resources.md). + +## Start Building Your First Interview! + +You probably already have an idea of the first form you want to work on, so get started! + +## Learn More + +If you've completed the above you are ready to get started building your first interview. But if you want a more in-depth beginner training, check out this 3.5–hour beginner training from [Docacon 2020](https://docacon.com/2020/index.html): + + \ No newline at end of file diff --git a/docs/plan_interview.md b/docs/get_started/plan_interview.md similarity index 99% rename from docs/plan_interview.md rename to docs/get_started/plan_interview.md index 0ab37abd5..0b9d14706 100644 --- a/docs/plan_interview.md +++ b/docs/get_started/plan_interview.md @@ -2,7 +2,7 @@ id: plan_interview title: Planning your interview sidebar_label: Planning your interview -slug: /planning +slug: /get_started/planning --- ## Planning and automating your first interview with the Assembly Line Framework diff --git a/docs/get_started/interview_building_resources.md b/docs/get_started/resources.md similarity index 97% rename from docs/get_started/interview_building_resources.md rename to docs/get_started/resources.md index 5a1a45522..6a7f6b1b0 100644 --- a/docs/get_started/interview_building_resources.md +++ b/docs/get_started/resources.md @@ -1,8 +1,8 @@ --- -id: interview_building_resources +id: resources title: Interview Building Resources sidebar_label: Resources -slug: /get_started/interview_building_resources +slug: /get_started/resources --- As you are building interviews, use these resources to find answers to your questions, solve problems you run into, and get help. diff --git a/docs/authoring/working_with_teams.md b/docs/get_started/working_with_teams.md similarity index 99% rename from docs/authoring/working_with_teams.md rename to docs/get_started/working_with_teams.md index 475474a6c..29e075eea 100644 --- a/docs/authoring/working_with_teams.md +++ b/docs/get_started/working_with_teams.md @@ -2,7 +2,7 @@ id: working_with_teams title: Working with teams sidebar_label: Working with teams -slug: /authoring/working_with_teams +slug: /get_started/working_with_teams --- ## Getting the project started diff --git a/docs/weaver_overview.md b/docs/weaver_overview.md index dac933c8a..54e738dbe 100644 --- a/docs/weaver_overview.md +++ b/docs/weaver_overview.md @@ -53,7 +53,7 @@ to continue editing your code. The steps that the Weaver will walk you through are as follows: 1. validate the labels and your template file -1. add some basic information about your form (follow the [planning your interview](plan_interview.md) to get this ready) +1. add some basic information about your form (follow the [planning your interview](/get_started/plan_interview.md) to get this ready) 1. add on-screen prompts for each labeled field 1. choose a datatype for each labeled field (for example: text, number, date) 1. organize the fields onto individual screens with headings and optional additional text diff --git a/docusaurus.config.js b/docusaurus.config.js index 309306af0..206461d2b 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -76,6 +76,10 @@ module.exports = { '@docusaurus/plugin-client-redirects', { redirects: [ + { + from: '/docs', + to: '/' + }, { from: '/docs/framework/efiling', to: '/docs/efiling/overview' @@ -124,6 +128,14 @@ module.exports = { from: '/docs/bootcamp', to: '/docs/archive/bootcamp' }, + { + from: '/docs/planning', + to: '/docs/get_started/planning' + }, + { + from: '/docs/authoring/working_with_teams', + to: '/docs/get_started/working_with_teams' + }, ] } ] diff --git a/sidebars.js b/sidebars.js index 37bb0a7de..c3db7db88 100644 --- a/sidebars.js +++ b/sidebars.js @@ -5,9 +5,10 @@ module.exports = { 'get_started/intro', 'get_started/al_project_architecture', 'get_started/installation', - // 'get_started/interview_builder_onboarding', - // 'get_started/interview_building_workflow', - // 'get_started/interview_building_resources', + 'get_started/beginners_guide', + 'get_started/plan_interview', + 'get_started/working_with_teams', + 'get_started/resources', { type: 'category', label: 'Setting up your team', @@ -35,8 +36,6 @@ module.exports = { type: 'category', label: 'Authoring interviews', items: [ - 'plan_interview', - 'authoring/working_with_teams', 'pdf_templates', 'docx_templates', 'authoring/dynamic_phrasing_based_on_values',