crate-docs-theme icon indicating copy to clipboard operation
crate-docs-theme copied to clipboard
verified publisher icon crate

Documentation feedback on /docs/links.md

Open amotl opened this issue 1 year ago • 3 comments

Educate readers about the inline / direct linking syntax of MyST.

{ref}`Overview <console-overview>`

amotl avatar Mar 04 '24 14:03 amotl

https://github.com/crate/cloud-docs/pull/55#discussion_r1511464819 also shows we need to add some example about linking to doc targets instead of ref labels, i.e. does that work already like this, or differently?

[](inv:croud#commands/clusters)

amotl avatar Mar 04 '24 17:03 amotl

See also:

  • https://github.com/executablebooks/MyST-Parser/issues/548
  • https://github.com/executablebooks/myst-enhancement-proposals/issues/9

amotl avatar Mar 05 '24 17:03 amotl