Skip to content

Add onboarding context to Install tutorial#1548

Draft
Copilot wants to merge 2 commits intongfrom
copilot/update-install-docs
Draft

Add onboarding context to Install tutorial#1548
Copilot wants to merge 2 commits intongfrom
copilot/update-install-docs

Conversation

Copy link
Contributor

Copilot AI commented Feb 14, 2026

User feedback identified missing context in the Install tutorial - newcomers didn't understand what docToolchain is, what prerequisites they need, or what to do after installation.

Changes

Added four sections to src/docs/020_tutorial/010_Install.adoc:

  • "What is docToolchain?" - Defines docToolchain as a Docs-as-Code tool, lists core benefits (version control integration, multi-format output, code sync, automation), links to detailed docs

  • "Before You Begin" - Explicit prerequisites:

    • Required: project for docs, CLI basics, Docker OR Java 17 (or willingness to auto-install)
    • Optional: AsciiDoc familiarity, text editor
  • "Installation Steps" - Section header to demarcate where installation begins

  • "What's Next?" - Post-installation paths:

    • New project: arc42 template or HTML generation tutorial
    • Existing docs: configuration guide
    • General: tasks reference, community discussions

The original installation instructions remain unchanged (included via include:: directive from manual).

Original prompt

This section details on the original issue you should resolve

<issue_title>Docs: Feedback for 'Install docToolchain'</issue_title>
<issue_description>

I'm trying to understand how to use docToolchain. Clearly there are givens that are known to those who are able to use this tool but are not at all mentioned. What is the starting point for someone who has never heard of this tool before?


#page: https://github.com/doctoolchain/doctoolchain/edit/ng/src/docs/020_tutorial/010_Install.adoc
#branch: ng</issue_description>

Comments on the Issue (you are @copilot in this section)


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

@netlify
Copy link

netlify bot commented Feb 14, 2026

Deploy Preview for dtc-docs-preview ready!

Name Link
🔨 Latest commit 8e57f60
🔍 Latest deploy log https://app.netlify.com/projects/dtc-docs-preview/deploys/6990e90d8d34880008c05a4b
😎 Deploy Preview https://deploy-preview-1548--dtc-docs-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

- Add "What is docToolchain?" section with key benefits
- Add "Before You Begin" section with prerequisites
- Add "Installation Steps" header for clarity
- Add "What's Next?" section to guide users after installation
- Improve onboarding for complete beginners

Addresses issue feedback about missing context for newcomers

Co-authored-by: rdmueller <1856308+rdmueller@users.noreply.github.com>
@sonarqubecloud
Copy link

Copilot AI changed the title [WIP] Update installation documentation for docToolchain Add onboarding context to Install tutorial Feb 14, 2026
Copilot AI requested a review from rdmueller February 14, 2026 21:30
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.

Docs: Feedback for 'Install docToolchain'

2 participants