-
Notifications
You must be signed in to change notification settings - Fork 1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
missing introduction to the format #52
Comments
Now I started reading rest of documentation and it is less problematic than expected as it is quite short and uncomplicated. But I will leave it open as first impression is quite poor (feel free to close is that is not a problem or not worth fixing). |
I think it should be more accessible (I can make a PR, ping me after processing ones that I already created) |
Agree, the first impression is bad. Let's add a really basic example, e.g. the one from
|
I think the duplicated |
https://github.com/public-transport/friendly-public-transport-format/blob/master/README.md describes the vision, without any examples of the format itself
it links to https://github.com/public-transport/friendly-public-transport-format/blob/master/spec/readme.md that has no introduction or basic examples. It immediately starts from "In order to be able to use this format in both static data and API responses, you may chose wether to reference an item by its id or inline the item as an object." what is a minor, not so important detail.
Maybe it would be better to start from a straightforward example of a simplest possible route?
In my case I am looking for a simple format for representing train/bus/plane routes and I prefer to avoid inventing my own from scratch. But I am also uninterested in looking through entire spec to implement simple things following it.
The text was updated successfully, but these errors were encountered: