docs: update docs to clarify path to documentation for previous versions of the validator

[lionel-nj]

Summary:

This PR clarifies the paths to documentation for previous versions of the validator
Expected behavior:

No code change.

Please make sure these boxes are checked before submitting your pull request - thanks!

• Run the unit tests with gradle test to make sure you didn't break anything
• Format the title like "feat: [new feature short description]". Title must follow the Conventional Commit Specification(https://www.conventionalcommits.org/en/v1.0.0/).
• Linked all relevant issues
• Include screenshot(s) showing how this pull request works and fixes the issue(s)

[barbeau]

IMHO this is still a bit confusing. For example, if I were new to the repo I'd think "There is a v2.0.0 in the list, but the below README also says v2.0.0 in the documentation, so they're probably the same".

I think there needs to be some explanation of what this README is, in context of the previous releases.

Maybe something like:

This README contains information for master branch of this project, which is under active development. If you'd like to view documentation for past releases of the project, see:

• v2.0.0
• v1.4.0

[lionel-nj]

Thanks for the clarification @barbeau.

[barbeau]

Thanks @lionel-nj. More comments below.

I'd strongly suggest you have someone that's not familiar with the steps walk through the docs for each version (1.4.0, 2.0.0, and current master branch) after the next set of edits and try to complete the steps to make sure everything is accurate and understandable.

[lionel-nj]

@isabelle-dr while working on documentation update, I included suggestions to fix #912, PTAL at e776d1b .

[barbeau]

@isabelle-dr while working on documentation update, I included suggestions to fix #912, PTAL at e776d1b .

I'd suggest nesting the 3 categories so it's clear they are all possible future rules:

• Possible future rules for:
  • GTFS Reference
  • GTFS Best Practices
  • Common cases of bad data

[isabelle-dr]

@lionel-nj just one thing to change here so the title "Common cases of bad data" matches the label we chose "Community rule".
After this, I think we're good to merge this PR.

[lionel-nj]

@lionel-nj just one thing to change here so the title "Common cases of bad data" matches the label we chose "Community rule".
After this, I think we're good to merge this PR.

Fixed in da7a817. Merging to master.