Skip to content

Comments

Restructure the documentation#5202

Merged
lildude merged 7 commits intomasterfrom
lildude/restructure-docs
Feb 26, 2021
Merged

Restructure the documentation#5202
lildude merged 7 commits intomasterfrom
lildude/restructure-docs

Conversation

@lildude
Copy link
Member

@lildude lildude commented Feb 8, 2021

Description

The README file has grown to massive proportions making it quite daunting to read and harder to maintain.

This PR restructures the documentation to move most of the content out of the README file and move it to individual files withing a /docs directory.

As part of this re-org I've also taken the opportunity to discourage the use of the macOS-supplied version of Ruby due to the problems it causes when installing charlock-holmes.

I've also expanded on the releasing docs for GitHub staff.

[Rest of the template has been removed as it doesn't apply]

@lildude lildude requested a review from a team as a code owner February 8, 2021 11:25
@lildude lildude requested review from Alhadis and pchaigno February 8, 2021 11:26
Copy link
Collaborator

@Alhadis Alhadis left a comment

Choose a reason for hiding this comment

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

I have conflicting feelings here. On one hand, this strikes me as the sensible, natural thing to do from both a maintenance and reader perspective.

On the other… well, I've seen a lot of folks deep-link to specific sections of Linguist's readme (both in discussions, docs, and commit logs), which means this change will introduce bit-rot. 😕 Moreover, there are tricks people use to make huge, single-page files more accessible and easier to navigate:

  1. Tables of contents linking to each heading.
    When it starts getting too lengthy, break it into columns.
  2. “Back to top” links.
    I personally find them bothersome, but I see these a lot, so it's clear many folks like 'em/
  3. Using <details> or <details open> to implement collapsible sections.
    This might work well for the Troubleshooting section, since impatient readers will likely be skimming each subsection looking for their relevant problem.

@lildude
Copy link
Member Author

lildude commented Feb 22, 2021

On the other… well, I've seen a lot of folks deep-link to specific sections of Linguist's readme (both in discussions, docs, and commit logs), which means this change will introduce bit-rot. 😕

I did think about this but I thought his was a small price to pay to properly segregate "function" from "support", hence I've included the very small docs ToC at the top of the README. This could be extended.

Moreover, there are tricks people use to make huge, single-page files more accessible and easier to navigate:

Indeed, but that introduces more complexity and doesn't help with the long-term maintenance or expansion of the docs.

@Alhadis
Copy link
Collaborator

Alhadis commented Feb 22, 2021

I did think about this but I thought his was a small price to pay to properly segregate "function" from "support"

Now that you mention it, I never noticed how sharply divided the readme's content was.

👍 then.

@lildude lildude merged commit b283444 into master Feb 26, 2021
@lildude lildude deleted the lildude/restructure-docs branch February 26, 2021 10:42
jen801

This comment was marked as spam.

jen801

This comment was marked as spam.

@github-linguist github-linguist locked as resolved and limited conversation to collaborators Jun 17, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants