Problem/Motivation

https://www.drupal.org/project/decoupled_menus_initiative/issues/3186589 discusses creating some technical documentation for getting started with decoupled Drupal, ideally with interactive examples. As part of efforts to complete work related to this initiative, I'd like to create a similar issue with smaller scope - specifically focused on creating some interactive developer focused documentation specific to decoupled menus.

Proposed resolution

* Look at using https://docusaurus.io/ for overall documentation
* Evaluate https://sandpack.codesandbox.io/ for interactive examples
* Host result on Gitlab pages (will require Gitlab pages and Gitlab CI being made available to all drupal.org projects, or creating a new general project for this)

Remaining tasks

* Create repository with documentation.
* Author documentation
* Add interactive examples
* Determine live Drupal instance that can serve as the API.
* Document how to update documentation.
* Configure gitlab CI / Gitlab Pages.

Issue fork decoupled_menus_initiative-3261427

Command icon Show commands

Start within a Git clone of the project using the version control instructions.

Or, if you do not have SSH keys set up on git.drupalcode.org:

  • developer-docs Comparecompare
About issue forks

Comments

brianperry created an issue. See original summary.

brianperry’s picture

brianperry
he/him
commented

We've been given access to Gitlab CI and Gitlab Pages, which should allow this to continue moving forward.

I've also been experimenting with Sandpack on the issue fork here: https://www.drupal.org/project/drupal_state/issues/3262663

brianperry’s picture

brianperry
he/him
commented
Issue tags: +FLDC2022

Did some initial experimentation with Docusaurus and Sandpack at Florida Drupal Camp. Pushed up a work in progress developer-docs branch.

brianperry’s picture

brianperry
he/him
commented

Pushed up some updates including a working Sandpack live code preview example. Was encountering some errors running it in dev mode, but found that things ran fine in an incognito window. So most likely one of my browser plugins is conflicting. Works fine in a production build either way.