Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve cross-linking of types in 'Pandoc Lua Filters' docs #10529

Open
0xdevalias opened this issue Jan 12, 2025 · 1 comment
Open

Improve cross-linking of types in 'Pandoc Lua Filters' docs #10529

0xdevalias opened this issue Jan 12, 2025 · 1 comment

Comments

@0xdevalias
Copy link

0xdevalias commented Jan 12, 2025

In the spirit of:

  • https://pandoc.org/CONTRIBUTING.html
    • Write or improve documentation. If you ran into a problem which took more time to figure out than expected, please consider to save other users from the same experience. People writing the documentation tend to lack an outside view, so please help provide one. Good documentation is both difficult and extremely important.

Describe your proposed improvement and the problem it solves.

In the Lua Filters documentation, there are generally 2 different sections for the various types, and their constructors. eg.

A pattern I've noticed is that the 'type' usually includes a cross-link to the 'constructor':

Values of this type can be created with the pandoc.Emph constructor.

Values of this type can be created with the pandoc.CodeBlock constructor.

But the 'constructor' doesn't seem to include a crosslink to the 'type', and usually only refers to the more generic Block / Inline:

Returns:

Returns:

  • CodeBlock element (Block)

While I was recently exploring writing a lua filter I found myself spending a lot of time jumping back and forth in the docs, and felt like it would be easier if those sections cross-linked to one another.

Describe alternatives you've considered.

I'm aware of this issue/PR, but the nuance is different:

This docs issue is also unrelated, except for improving the docs UX for new users in general:

@jgm
Copy link
Owner

jgm commented Jan 13, 2025

@tarleb what do you think?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants