Update overview and accessibility docs [ci skip] #5680
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## dev-2.x #5680 +/- ##
=============================================
- Coverage 67.88% 67.88% -0.01%
+ Complexity 16559 16558 -1
=============================================
Files 1908 1908
Lines 72355 72355
Branches 7443 7443
=============================================
- Hits 49120 49119 -1
- Misses 20714 20715 +1
Partials 2521 2521 ☔ View full report in Codecov by Sentry. |
docs/Accessibility.md
Outdated
| currently limits implementation and discussion in this document to this binary | ||
| "wheelchair accessible" definition. | ||
|
|
||
| The term "accessibility" has a completely separate, unrelated definition in the fields of |
There was a problem hiding this comment.
Who is the intended audience for this explanation?
There was a problem hiding this comment.
The audience is people who search for "OTP accessibility" when looking for analysis uses and land on this page of the docs. People who are trying to understand the situation with travel time surfaces and isochrones, and ending up on the wrong page. It is indeed a bit out of place here.
The ideal would be to expand and revise the other page that is specifically about analysis uses. That other page will probably just redirect people to other tools (after giving them some background in case they're following up on past projects / articles). Then this page (on the more common meaning of accessibility) would only need a single sentence along the lines of "if you're looking for the other meaning of accessibility, see analysis page (link)".
So I'll just move this text over to the analysis page and suggest a short link here.
There was a problem hiding this comment.
I think that would be great.
There was a problem hiding this comment.
This update to the analysis docs page has long been on my mind since we talked about it in the past. But my sense in meetings is always that the fate/state of isochrone and one-to-many functionality is still being decided and I am not yet sure of those final decisions. But I think we can get this finalized soon.
There was a problem hiding this comment.
Entur have publicly stated that they want to remove it, but haven't actually done it.
moved info out of v1-v2 comparison and accessibility pages
abyrd
changed the title
This PR updates a couple of documentation pages for clarity.
The project overview page in the docs mentions OSM data first, followed by other formats without mentioning that they represent public transit service. This may be contributing to many first-time readers' impression that OTP is primarily intended or suited for bulk point-to-point street routing.
The modified text clearly states the purpose of public transit and bicycle sharing data sources. It also states that the data formats are open standards which has always been important to the project.
The update to the accessibility page is meant to anticipate questions and emails we've fielded over the years, from people confused (and possibly somewhat offended) by the use of "accessibility" to mean different things in different fields. Some people will land on the OTP documentation from web searches for the word "accessibility" intending multiple different meanings. This is also a first step toward providing clearer information on OTP's position on isochrone and travel time surface outputs. Links are provided to existing pages that touch on this subject. A final page on the subject will be added once that discussion is finalized.