Skip to content
  • Mike's avatar
    [docs] Remove duplicated instructions (#18913) · 841ec0c2
    Mike authored and Philip Jägenstedt's avatar Philip Jägenstedt committed
    Prior to this commit, an explanation of the project's linting tool was
    available in both the project "readme" file and the project's "docs/"
    directory. This duplication was susceptible to synchronization problems,
    as evidenced by the readme's reference to an executable file which was
    deleted two years ago [1].
    
    In general, it's preferable to store technical instruction in the
    "docs/" directory because of its hierarchical structure; the project's
    web site is generated based on that structure, offering visitors a more
    approachable way to traverse the information. The "flat" nature of the
    readme file makes it less ideal for conveying information to a wide and
    varied audience.
    
    Remove the discussion of the linting tool from the "readme" file. This
    removal does not reduce the amount of information available because the
    same instructions are already present in the relevant location within
    the `docs/` directory.
    
    [1] 555c9bd0
    841ec0c2