OpenFn / OpenFn/lightning

Docs widget not respecting indentation

Open
#2,832 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug
Dominant language
Elixir
Stars
296
Forks
86
Avg merge
1d 13h
Merged PRs (30d)
50

Description

In the dhis2 adaptor, we see that the examples are properly indented using spaces. Great!

On the docs site, we see that these indented examples are rendered properly in the code block. Great!
Image

But on lightning, in the docs widget, we've somehow lost those spaces and it's improperly indented. Boo!
Image

And even when we click "add" via the docs widget, the code that's added to the editor is improperly indented. Boo!
Image

Somewhere we must be losing the formatting. It's making the docs widget and code added to the editor hard to read and unprofessional.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the dhis2 adaptor examples linked in the issue, then trace how the docs widget renders them and how its “add” action inserts code into the editor. Reproduce the indentation loss in both places and verify that the original spacing is preserved in the widget and in inserted editor code.

Written by the indexing model from the issue text.

Assessment

Tech stack
elixir
Domain
documentation, frontend
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.