posit-dev / posit-dev/ark

Hard-to-read tables in markdown help pages

Open
#744 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
337
Forks
32
Avg merge
8d 17h
Merged PRs (30d)
11

Description

Hi :)

I've been toying with integrating Ark with Neovim via ark.nvim. Happily, my experience so far has been really good. However, one minor annoyance is that LSP formatting of 'Arguments' sections is a bit hard to read:

Image

I think Positron requests HTML from Ark, rather than requesting markdown and converting to HTML downstream. If this is the case, would you be open to a pull request to change the formatting here, just for the markdown option, e.g. to use a bullet list or similar?

I'm very aware that ark.nvim is (currently) something of an off-label use for Ark, as the README clearly states that the LSP/DAP servers aren't yet available for other editors. With this in mind, I also wanted to ask if Ark is currently open to issues/contributions like this one, which are aimed at making Ark more ergonomic for other editors? If not, please do let me know and I'll be happy to hold off with any similar questions until that changes.

Thank you!

Contributor guide

Open the contributing guide

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

The issue names no file, test, or entry point. Start by locating the markdown renderer for help-page “Arguments” sections and confirm which output path is used; done means the markdown presentation is easier to read without changing the HTML option.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.