search

artefactual-sdps / enduro

A tool to support ingest and automation in digital preservation workflows
https://enduro.readthedocs.io/
Apache License 2.0
4 stars 3 forks source link

Problem: formatting issues in Working with Archivematica docs #837

Closed sevein closed 5 months ago

sevein commented 5 months ago

Describe the bug

There are some formatting issues in [Working with Archivematica](Working with Archivematica https://enduro.readthedocs.io/dev-manual/archivematica/) introduced by https://github.com/artefactual-sdps/enduro/pull/828 and https://github.com/artefactual-sdps/enduro/pull/830.

To Reproduce

Steps to reproduce the behavior:

  1. Visit https://enduro.readthedocs.io/dev-manual/archivematica/.
  2. Look at the formatting issues.
  3. Experience visual discomfort.
  4. Feel the urge to fix ASAP.
Diogenesoftoronto commented 5 months ago

I tried to change this Unfortunately it does not seem read the docs actually renders checkboxes which is a bit annoying

sevein commented 5 months ago

It looks like mkdocs doesn't support tasks lists: https://www.markdownguide.org/tools/mkdocs/. I think that you have a couple of options:

  1. Use this Tasklist extension, or
  2. Use a nested list.

I'd rather go with the second option, for me these checkboxes are misleading because we're not really providing any interactivity.

Diogenesoftoronto commented 5 months ago

It looks like mkdocs doesn't support tasks lists: markdownguide.org/tools/mkdocs. I think that you have a couple of options:

  1. Use this Tasklist extension, or
  2. Use a nested list.

I'd rather go with the second option, for me these checkboxes are misleading because we're not really providing any interactivity.

I am going to remove the checklist, I think there is a way to add interactivity but it does not look great because it won't persist (there are workarounds i think we could make that use local storage but after talking to @joel-simpson I do not think it is worth it.)