sphinx-doc / sphinx

The Sphinx documentation generator
https://www.sphinx-doc.org/
Other
6.61k stars 2.13k forks source link

Make a dedicated section for cross-reference syntax in docs #12984

Closed timhoffm closed 1 month ago

timhoffm commented 1 month ago

... and rename the current "Cross-referencing syntax" page to "Cross-references", of which "Syntax" is one subsection.

This section naming fits better to the current content structure. It also allows to distinguish between links to the general cross-referencing topic, and specific links to the syntax.

A small step towards solving #12980.

AA-Turner commented 1 month ago

@timhoffm I sent you an invitation to the Sphinx organisation so that you can edit properties on PRs etc -- let me know if it came through.

A

timhoffm commented 1 month ago

@timhoffm I sent you an invitation to the Sphinx organisation so that you can edit properties on PRs etc -- let me know if it came through.

A

Thanks, I've accepted. Do you have any written guidelines on triaging, or should I just use it (defensively) as I see fit and you correct me if I'm going wrong somewhere?

AA-Turner commented 1 month ago

We have https://www.sphinx-doc.org/en/master/internals/contributing.html but it is somewhat sparse.

Perhaps @picnixz or @jayaddison have thoughts here but my rules of thumb are:

We should be better at closing issues and rejecting feature requests, but that is often hard.

A

jayaddison commented 1 month ago

I'd mention a few things related to discussions:

(probably based on my own biases, experiences and approach, but figured I'd share them anyway)

electric-coder commented 1 month ago

@timhoffm congratulations on becoming a triager. Here are 2 thoughts:

  1. Try to always add a language code to every source fence. A lot of users don't know how to do this making their snippets hard to read thus degrading the quality of reports overall.
  2. Take a good look at the tag (label) system and use it to retag reports appropriately.