Behat / docs

Behat documentation repository
http://behat.org
28 stars 69 forks source link

Update docs on config file location #145

Closed uuf6429 closed 3 weeks ago

uuf6429 commented 4 weeks ago

Addendum to https://github.com/Behat/Behat/pull/1464.

@stof I'm not used to RST format, or even the code style...so please let me know if I missed anything.

carlos-granados commented 4 weeks ago

@uuf6429 @acoulton

I opened the file in an online rst viewer and it did not look correct, see the image.

Screenshot 2024-10-24 at 09 01 15

But maybe whatever generates the HTML files for the site interprets this differently. It would be good to know how this HTML is exactly generated and to learn how to do it locally for testing. @everzet @stof do you have any info that you could share about this process? Thanks!

uuf6429 commented 4 weeks ago

@carlos-granados good call! Using documatt, I got the same result as you did.

After adding some blank lines, it seemed to render well (so I've pushed the changes).

acoulton commented 4 weeks ago

Thanks for checking it properly @carlos-granados - viewing the updated file in documatt it looks good - I've also discovered that on desktop clicking "View file" from the pull request diff shows the whole file rendered by github which also looks good.