Use real examples in API code examples

[jidanni]

Please change

    "last_read_at":"last_read_at"

to

   "last_read_at":"2014-11-07T22:01:45Z"

They occur in
$ w3m -dump https://docs.github.com/en/free-pro-team@latest/rest/reference/activity | grep -n last_read_at.*:.*last_read_at

973:  -d '{"last_read_at":"last_read_at"}'
978:  last_read_at: 'last_read_at'
1524:  -d '{"last_read_at":"last_read_at"}'
1531:  last_read_at: 'last_read_at'

However they are not accessible from
https://github.com/github/docs/edit/main/content/rest/reference/activity.md
for me to edit. Nor does Search find what file they are in. Therefore
please make the edit for me. Thanks.

[welcome]

Thanks for opening this issue. A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

[janiceilene]

Thanks for opening an issue @jidanni! I believe that information is autogenerated 🤔 but I'll triage this for someone with more knowledge on our rest documentation 💛

[lucascosti]

👋 @jidanni.

Our API documentation is autogenerated from the API code, which is why you can't find it in the source in this docs repo.

Please change

    "last_read_at":"last_read_at"

I assume you're referring to the code examples? e.g here

These are also autogenerated and at the moment just have placeholder values. We do have plans to generate these with proper examples rather than the placeholders you see.

I'll rename this issue and tag in docs engineering too 🙂

[jidanni]

I assume you're referring to...

Yes.

I don't see why impossible/non-working code sample are used, when directly below it real/working ones are used.

[lucascosti]

I don't see why impossible/non-working code sample are used, when directly below it real/working ones are used.

For integers in examples, it always uses 42 as the number in the code samples. For strings, our generator just defaults to just using the name of the parameter as the example string.

We have plans to improve this to use real examples generated from our schema, so stay tuned! 🙂

[runleonarun]

moved this to docs engineering to prioritize

[github-actions]

This issue is stale because it has been open 60 days with no activity.

[chiedo]

👋🏿 @jidanni we're working on this internally, so I'm going to close this issue up. Thanks so much for your passion about docs! We're aiming at having an improved API examples experience for you in the future!