FLUID-5829: Fixes to Renderer docs

Metadata

Source
FLUID-5829
Type
Task
Priority
Major
Status
Closed
Resolution
Fixed
Assignee
N/A
Reporter
Anastasia Cheetham
Created
2015-12-10T11:16:41.455-0500
Updated
2024-07-22T10:35:00.345-0400
Versions
N/A
Fixed Versions
N/A
Component
  1. Tech. Documentation

Description

Some issues were found in various Renderer-related documentation:

Renderer.html

  • "markup agnoticism" link should link to "markup agnoticism" section of the Framework Concepts document

HowToUseTheRenderer.html

  • "parent grade" link should jump to "Specifying parent grades" section of the Component Grades document?
  • fluid.render link goes to specific lines in code in github - these lines may change over time - should we hard-code such references in the docs? Perhaps better to generalize it by saying "See fluid.render on this page".

Renderer Components:

  • Prototree link is broken
  • Produce tree link is broken
  • contains bad link to ../to-do/Components.html

Renderer Component Trees:

  • broken link (404) to Infusion Components in first paragraph of Renderer Component Trees

Comments

  • YashJipkate commented 2020-04-08T15:45:24.189-0400

    The 'Renderer Components' and the 'Renderer Component Trees' sections are already fixed in the latest master branch. I have fixed the other two parts in [this PR|https://github.com/fluid-project/infusion-docs/pull/179]

    For the 2nd point of 'HowToUseTheRenderer', I have used permalink for the concerned block of code it links to so that the links do not point to any unexpected lines. I did this because I think that saying 'See fluid.render on this page' would be too vague.