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

Rename Renderers page to List of renderers #10240

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

Calinou
Copy link
Member

@Calinou Calinou commented Nov 10, 2024


  • Put it first in the list of pages in the Rendering section, as it makes more sense to be read first.

- Put it first in the list of pages in the Rendering section,
  as it makes more sense to be read first.
@Calinou Calinou added enhancement area:manual Issues and PRs related to the Manual/Tutorials section of the documentation labels Nov 10, 2024
Copy link
Contributor

@tetrapod00 tetrapod00 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This seems good, but I want to clarify why the page is called renderers.rst. I initially wanted to write a page with just the comparison table, but saw that there was a lack of information about the renderers (besides the technical Internal Rendering Architecture page). Over time I believe that the Renderers page will grow like this:

  1. Add the page (we are here):
  • Renderers page
    • Intro section
    • Comparison table section
  1. Add info about each renderer to a section, as we add or transfer information about renderers:
  • Renderers page
    • Intro
    • Forward+ section
    • Mobile section
    • Compatibility section
    • Comparison
  1. The section on each renderer becomes a page (this is as far as I'm pretty sure we'll get):
  • Renderers index page (this one still has the doc_renderers anchor despite all the changes)
    • Intro + Comparison page
    • Forward+ page
    • Mobile page
    • Compatibility page
  1. Potentially add some other pages which are about renderers, not rendering in general, but don't fit in any existing page, and split out the table to a full page:
  • Renderers index page
    • Intro
    • Forward+
    • Mobile
    • Compatibility
    • Supporting multiple renderers page
    • Comparison of renderers page

So I named the page rendererers.rst and "Renderers", rather than "Renderer comparison" or "List of renderers", in anticipation of this. I think "List of renderers" or "Renderer comparison" is the better name for the page as it currently exists, so this change seems good, as long as the anchor and filename are left as they are and the page title can be renamed again later if needed.

@skyace65
Copy link
Contributor

What is the issue with the current name? The page isn't just a list of renderers, it gives information on which is best for your needs and a breakdown of what features are supported on which. I just don't see much of a point with this change.

@mhilbrunner
Copy link
Member

Yeah, I don't disagree. I'm fine with the change (and tetrapod seems too), but I'm not sure "Renderers" isn't fine as is.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:manual Issues and PRs related to the Manual/Tutorials section of the documentation enhancement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants