Skip to content

Align website docs entry points with Diátaxis (Tutorials / How-to / Reference / Explanation)#1930

Closed
Copilot wants to merge 2 commits intomainfrom
copilot/improve-documentation-diataxis
Closed

Align website docs entry points with Diátaxis (Tutorials / How-to / Reference / Explanation)#1930
Copilot wants to merge 2 commits intomainfrom
copilot/improve-documentation-diataxis

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Feb 28, 2026

Proposed changes

Applied a minimal Diátaxis-oriented update in website/docs so readers can quickly choose the right documentation type (learn, solve, lookup, understand) without restructuring the docs tree.

  • Diátaxis labeling in sidebar categories

    • Renamed category labels to map to Diátaxis:
      • BasicsTutorials
      • UsageHow-to guides
      • CLIReference
  • Diátaxis routing from Intro

    • Rewrote the opening section of docs/intro.md to explicitly direct users to:
      • Tutorials (getting-started)
      • How-to guides (usage guide entry path)
      • Reference (CLI docs)
      • Explanation (architecture, concepts, FAQ)
  • Example snippet (intro mapping)

    - **Tutorials** for learning by doing: [Getting started](/docs/basics/getting-started)
    - **How-to guides** for solving specific tasks: [Usage guides](/docs/usage/chaining)
    - **Reference** for commands and exact behavior: [CLI reference](/docs/cli/dkron)
    - **Explanation** for understanding concepts and design: [Architecture](/docs/architecture), [Concepts](/docs/usage/concepts), [FAQ](/docs/faq)
  • Screenshot

Types of changes

What types of changes does your code introduce?
Put an x in the boxes that apply

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation Update (if none of the other choices apply)

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • 127.0.0.10
    • Triggering command: /tmp/go-build1628342049/b1335/dkron.test /tmp/go-build1628342049/b1335/dkron.test -test.testlogfile=/tmp/go-build1628342049/b1335/testlog.txt -test.paniconexit0 -test.timeout=10m0s -test.v=true 8342049/b1046/_p-errorsas -trimpath (packet block)
  • 127.0.0.11
    • Triggering command: /tmp/go-build1628342049/b1335/dkron.test /tmp/go-build1628342049/b1335/dkron.test -test.testlogfile=/tmp/go-build1628342049/b1335/testlog.txt -test.paniconexit0 -test.timeout=10m0s -test.v=true 8342049/b1046/_p-errorsas -trimpath (packet block)
  • 127.0.0.13
    • Triggering command: /tmp/go-build1628342049/b1335/dkron.test /tmp/go-build1628342049/b1335/dkron.test -test.testlogfile=/tmp/go-build1628342049/b1335/testlog.txt -test.paniconexit0 -test.timeout=10m0s -test.v=true 8342049/b1046/_p-errorsas -trimpath (packet block)
  • 127.0.0.14
    • Triggering command: /tmp/go-build1628342049/b1335/dkron.test /tmp/go-build1628342049/b1335/dkron.test -test.testlogfile=/tmp/go-build1628342049/b1335/testlog.txt -test.paniconexit0 -test.timeout=10m0s -test.v=true 8342049/b1046/_p-errorsas -trimpath (packet block)
  • client.badssl.com
    • Triggering command: /tmp/go-build1628342049/b1349/http.test /tmp/go-build1628342049/b1349/http.test -test.testlogfile=/tmp/go-build1628342049/b1349/testlog.txt -test.paniconexit0 -test.timeout=10m0s -test.v=true 8342049/b1042/_p-errorsas x64/src/testing/-ifaceassert ux_amd64/vet -p .io/otel/exporte-atomic -lang=go1.16 ux_amd64/vet -o 8342049/b1122/_p-errorsas pkg/mod/k8s.io/c-ifaceassert ux_amd64/vet -p c/semaphore -lang=go1.16 ux_amd64/vet (dns block)
  • scarf.sh
    • Triggering command: /home/REDACTED/work/_temp/ghcca-node/node/bin/node node ./report.js -lang=go1.23 ux_amd64/compile--others -ato�� -bool -buildtags ux_amd64/vet -errorsas -ifaceassert -nilfunc ux_amd64/vet -uns�� re re ux_amd64/vet oc.go enerated_expansi/home/REDACTED/work/dkron/dkron/website/node_modules/.bin/node-gyp-build (dns block)
  • self-signed.badssl.com
    • Triggering command: /tmp/go-build1628342049/b1349/http.test /tmp/go-build1628342049/b1349/http.test -test.testlogfile=/tmp/go-build1628342049/b1349/testlog.txt -test.paniconexit0 -test.timeout=10m0s -test.v=true 8342049/b1042/_p-errorsas x64/src/testing/-ifaceassert ux_amd64/vet -p .io/otel/exporte-atomic -lang=go1.16 ux_amd64/vet -o 8342049/b1122/_p-errorsas pkg/mod/k8s.io/c-ifaceassert ux_amd64/vet -p c/semaphore -lang=go1.16 ux_amd64/vet (dns block)
  • untrusted-root.badssl.com
    • Triggering command: /tmp/go-build1628342049/b1349/http.test /tmp/go-build1628342049/b1349/http.test -test.testlogfile=/tmp/go-build1628342049/b1349/testlog.txt -test.paniconexit0 -test.timeout=10m0s -test.v=true 8342049/b1042/_p-errorsas x64/src/testing/-ifaceassert ux_amd64/vet -p .io/otel/exporte-atomic -lang=go1.16 ux_amd64/vet -o 8342049/b1122/_p-errorsas pkg/mod/k8s.io/c-ifaceassert ux_amd64/vet -p c/semaphore -lang=go1.16 ux_amd64/vet (dns block)

If you need me to access, download, or install something from one of these locations, you can either:


🔒 GitHub Advanced Security automatically protects Copilot coding agent pull requests. You can protect all pull requests by enabling Advanced Security for your repositories. Learn more about Advanced Security.

Co-authored-by: vcastellm <47026+vcastellm@users.noreply.github.com>
Copilot AI changed the title [WIP] Enhance documentation using Diataxis principles Align website docs entry points with Diátaxis (Tutorials / How-to / Reference / Explanation) Feb 28, 2026
@vcastellm vcastellm closed this Mar 29, 2026
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.

2 participants