Restructure documentation for better usability

Created on 6 August 2024, 4 months ago
Updated 7 August 2024, 4 months ago

Problem/Motivation

The current readme and project page β†’ are lengthy and contain both high-level information and detailed instructions. Too much content on a page can create challenges for cognitive accessibility.

Proposed resolution

  • Create a docs folder at the root of the repository and move more detailed instructions into separate markdown files inside that folder with links from the readme and project page.
  • Add table of contents to the top of lengthy pages to allow faster navigation

I took a pass at moving the "Running a Batch Operation instructions" & FAQ to sub pages and zipped the whole directory https://www.drupal.org/files/issues/2024-08-06/codit.zip β†’

✨ Feature request
Status

Needs review

Version

1.0

Component

Documentation

Created by

πŸ‡ΊπŸ‡ΈUnited States davidmpickett

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Merge Requests

Comments & Activities

  • Issue created by @davidmpickett
  • πŸ‡ΊπŸ‡ΈUnited States davidmpickett
  • πŸ‡ΊπŸ‡ΈUnited States davidmpickett

    Commenting for credit attribution

  • Status changed to Active 4 months ago
  • πŸ‡ΊπŸ‡ΈUnited States davidmpickett
  • First commit to issue fork.
  • Merge request !25Documentation updates β†’ (Open) created by davidmpickett
  • Pipeline finished with Success
    4 months ago
    Total: 145s
    #246213
  • Status changed to Needs review 4 months ago
  • πŸ‡ΊπŸ‡ΈUnited States swirt Florida

    Thankyou @davidmpickett for this amazing work. I do appreciate all you put into this. And props for putting it in a MR!!

    This one is going to have to percolate in my head for a bit.
    Right now I keep all the documentation in the one file because it feeds

    1. The main page in the git repo
    2. The project page on Drupal.org
    3. The internal help link that appears directly in Drupal

    I do it like this because Drupal has built-in helpers that allow me to connect all three. And I do it that way across the many modules I maintain, mainly to keep me sane (not having to maintain different documentation locations).

    There is really no tooling right now to connect multiple markdown files in both the help page and the module's project page. The existing tooling oddly does not digest links well. ie Either links work on the project page, but not the help page, or vice versa.

    I need to give some more thought to this for a bit to see if I can come up with a way to make this work smoothly on all three use cases. Ultimately, yours is the better way, so I want to get there as soon as I figure out how.

Production build 0.71.5 2024