Skip to content

Add task-oriented recipes page to the docs#24

Merged
erseco merged 2 commits intomainfrom
copilot/create-roadmap-task
Mar 16, 2026
Merged

Add task-oriented recipes page to the docs#24
erseco merged 2 commits intomainfrom
copilot/create-roadmap-task

Conversation

Copy link
Contributor

Copilot AI commented Mar 16, 2026

The roadmap calls for task-oriented documentation recipes, but the docs currently skew toward reference material and broad examples. This PR adds a focused recipes page with copy/paste workflows for common operator and contributor tasks.

  • New documentation surface

    • Adds docs/recipes.md as a dedicated task-oriented guide
    • Covers common workflows:
      • verify environment/login
      • inspect a course before changes
      • create a course and add a welcome label
      • upload materials into a folder
      • run the fastest contributor validation loop
  • Navigation

    • Registers the new page in mkdocs.yml so it is discoverable from the top-level docs nav
  • Docs shape

    • Positions recipes between examples and troubleshooting:
      • examples remain illustrative
      • recipes are operational and copy/paste-ready
      • troubleshooting remains failure-oriented

Example recipe:

py-moodle --env local site info

py-moodle courses list
py-moodle courses show 2
py-moodle sections list 2

Recipes page


📍 Connect Copilot coding agent with Jira, Azure Boards or Linear to delegate work to Copilot in one click without leaving your project management tool.

Co-authored-by: erseco <1876752+erseco@users.noreply.github.com>
Copilot AI changed the title [WIP] Add roadmap task Add task-oriented recipes page to the docs Mar 16, 2026
Copilot AI requested a review from erseco March 16, 2026 13:42
@erseco erseco marked this pull request as ready for review March 16, 2026 14:33
@erseco erseco merged commit d0924d6 into main Mar 16, 2026
13 checks passed
@erseco erseco deleted the copilot/create-roadmap-task branch March 16, 2026 14:33
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