datasets template guide :: issue in documentation YAML
MEMBER
Hello, @bghira.

Thanks for reporting. Please note that the text originating the error is not supposed to be valid YAML: it contains the instructions to generate the actual YAML content, that should replace the instructions comment.

On the other hand, I agree that it is not nice to have that YAML error message at the top of the page: 
![Screenshot from 2024-05-14 06-58-02](https://github.com/huggingface/datasets/assets/8515462/28409eb4-99e7-4b24-8eaa-21a65a8f23b2)

I am proposing a change to make the YAML error disappear.
2024-05-14T05:03:29Z
https://github.com/huggingface/datasets/issues/6897#issuecomment-2109291040
https://api.github.com/repos/huggingface/datasets/issues/6897
IC_kwDODunzps59uTog
https://api.github.com/repos/huggingface/datasets/issues/comments/2109291040/reactions
2024-05-14T05:03:29Z
https://api.github.com/repos/huggingface/datasets/issues/comments/2109291040
https://avatars.githubusercontent.com/u/8515462?v=4
https://api.github.com/users/albertvillanova/events{/privacy}
https://api.github.com/users/albertvillanova/followers
https://api.github.com/users/albertvillanova/following{/other_user}
https://api.github.com/users/albertvillanova/gists{/gist_id}
https://github.com/albertvillanova
albertvillanova
MDQ6VXNlcjg1MTU0NjI=
https://api.github.com/users/albertvillanova/orgs
https://api.github.com/users/albertvillanova/received_events
https://api.github.com/users/albertvillanova/repos
https://api.github.com/users/albertvillanova/starred{/owner}{/repo}
https://api.github.com/users/albertvillanova/subscriptions
User
https://api.github.com/users/albertvillanova
public
NONE
thanks albert! i looked at it for a while to figure it out. i think the `raw` view option is the correct way to look at it?
2024-05-14T12:08:49Z
https://github.com/huggingface/datasets/issues/6897#issuecomment-2110038010
https://api.github.com/repos/huggingface/datasets/issues/6897
IC_kwDODunzps59xJ_6
https://api.github.com/repos/huggingface/datasets/issues/comments/2110038010/reactions
2024-05-14T12:08:49Z
https://api.github.com/repos/huggingface/datasets/issues/comments/2110038010
https://avatars.githubusercontent.com/u/59658056?v=4
https://api.github.com/users/bghira/events{/privacy}
https://api.github.com/users/bghira/followers
https://api.github.com/users/bghira/following{/other_user}
https://api.github.com/users/bghira/gists{/gist_id}
https://github.com/bghira
bghira
MDQ6VXNlcjU5NjU4MDU2
https://api.github.com/users/bghira/orgs
https://api.github.com/users/bghira/received_events
https://api.github.com/users/bghira/repos
https://api.github.com/users/bghira/starred{/owner}{/repo}
https://api.github.com/users/bghira/subscriptions
User
https://api.github.com/users/bghira
public
### Describe the bug

There is a YAML error at the top of the page, and I don't think it's supposed to be there 

### Steps to reproduce the bug

1. Browse to [this tutorial document](https://github.com/huggingface/datasets/blob/main/templates/README_guide.md)
2. Observe a big red error at the top
3. The rest of the document remains functional

### Expected behavior

I think the YAML block should be displayed or ignored.

### Environment info

N/A